docs: upgrade Vellum to 0.3.0 - #131
Merged
Merged
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (2)
Disabled knowledge base sources:
📝 WalkthroughWalkthroughThe project updates five ChangesVellum Docs upgrade
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: Poem
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
cellfilter andTypeString.onelinesupport for Markdown-table-safe SDK typesWhy
Vellum 0.3 replaces repeated table escaping chains with the profile-aware
cellfilter. The Eve integration page can therefore render its SDK-extracted option types with{{ option.type | cell | safe }}instead of maintaining five string replacements.Compatibility
Vellum 0.3 enables strict Nunjucks rendering by default. The current synced Spectrum templates include a reference to an authoring symbol that is present on Spectrum main but not in the published
spectrum-ts@12.0.0package indexed by the aggregator. This PR setsstrict: falseexplicitly to preserve the existing build behavior while gaining the additive table-cell helpers. Strict rendering can be enabled separately after the synced sources and published packages are aligned.Validation
pnpm install --frozen-lockfilepnpm docs:generate(662 symbols extracted, 85 templates rendered)cell(458 symbols extracted, two templates rendered)pnpm lintpnpm typecheck:docsgit diff --checkNeed help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.Note
Low Risk
Dependency and docs-build config only; no runtime app logic. The explicit
strict: falsereduces risk of broken doc generation during the minor upgrade.Overview
Bumps all
@vellum-docs/*dev dependencies from 0.2.4 to 0.3.0 (with matchingpnpm-lock.yamlupdates, including new CLI transitives such aschokidar).Updates
vellum.config.tsto instantiateNunjucksEngine({ strict: false })so doc generation keeps the prior non-strict Nunjucks behavior while on 0.3, which turns strict rendering on by default.Reviewed by Cursor Bugbot for commit 0291cb1. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit