docs: replace Jekyll with VitePress documentation site#2720
Conversation
a52aef5 to
618cb64
Compare
Delete the Jekyll-based documentation site including: - _config.yml, _layouts, _includes, _sass, _data themes - Jekyll assets, how-to guides, release-source docs - Versioned release documentation infrastructure - Root Gemfile and Gemfile.lock
618cb64 to
7df5312
Compare
Replace the old docs with a VitePress-based site featuring: - Modern search, dark mode, and fast builds - Executable documentation examples via tap (imported via symlink) - Auto-generated sidebar from concept index pages - LLM-friendly plaintext output via vitepress-plugin-llms - Isolated dependencies in docs/package.json - Scripts for link-checking and sidebar generation
Remove Jekyll-related npm scripts from root package.json: - docs:watch, lint:docs, docs:check-links Remove versioned docs release copying from postversion.sh. The new VitePress docs are built and deployed via GitHub Actions.
Replace Jekyll setup instructions with VitePress equivalents: - Local dev server via npm run docs:dev - Build and preview commands - Documentation testing instructions
7df5312 to
6659c37
Compare
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
Warning Review the following alerts detected in dependencies. According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.
|
9579227 to
f9ba1dd
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2720 +/- ##
=======================================
Coverage 97.40% 97.40%
=======================================
Files 39 39
Lines 1810 1810
=======================================
Hits 1763 1763
Misses 47 47
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
CodeQL Configuration NoteThis PR removes the last of the Ruby/Jekyll code from the repository. The existing CodeQL Default Setup is currently configured to scan Ruby, which will no longer find any source files to analyze. What needs to change at merge timeGo to Settings → Security → Code security and analysis → Code scanning → Default setup and either:
About the new workflow
If left as-is, the Default Setup will likely show a configuration warning (or silently no-op) once the Ruby files are gone. |
Build, link-check, and deploy the VitePress docs site to GitHub Pages on every push to main. Requires switching Pages source to GitHub Actions after merge.
f9ba1dd to
962306a
Compare
Summary
This PR replaces the Jekyll-based documentation site with a VitePress-based site.
Changes
docs/package.jsonfor isolated docs dependencies.github/workflows/docs.ymlfor CI build, link-check, and GitHub Pages deploymentCONTRIBUTING.mdwith VitePress local setup instructionsscripts/postversion.shto remove docs release copyingGemfile/Gemfile.lock(Jekyll no longer needed)Local setup
cd docs npm install npm run docs:devOther commands (run from
docs/):npm run docs:build— production buildnpm run docs:preview— preview production buildnpm run test:docs— run executable documentation examplesnpm run docs:link-check— verify linksDeployment
GitHub Actions builds and deploys the site on every push to
main.Action required for maintainers
After merging, go to Settings > Pages and switch the source from "Deploy from a branch" to "GitHub Actions".
Versioned docs
Versioned documentation is no longer maintained. Only the latest docs are published.