Remove VuePress; publish docs as plain Markdown#561
Merged
Conversation
Drop the VuePress toolchain and doc-site publish pipeline so docs are plain Markdown browsable on GitHub. - Delete VuePress config, npm tooling, deploy scripts, and docs .gitignore - Delete deploy-document.yml GitHub Actions workflow (built/pushed gh-pages) - Add docs/README.md index and a Documentation contents ToC to EN/JA READMEs - Update AGENTS.md, dev-docs, and development-workflow skill to describe plain Markdown docs - Add ADR 0005 recording the decision Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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
2 participants
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.
What
Removes the VuePress dependency so the documentation under
docs/is just plain Markdown that reads fine when browsing the folder on GitHub. No site generator, no npm toolchain, no bespoke publish pipeline.Scope
Addresses items 1 & 2 of the request:
1. Remove VuePress config / tooling
docs/docs/.vuepress/config.jsdocs/package.json,docs/package-lock.jsondocs/deploy.ps1,docs/deploy.shdocs/.gitignore(only ignorednode_modules/and the VuePressdist/)2. Remove the doc-site publish GitHub Actions workflow
.github/workflows/deploy-document.yml(built VuePress and force-pushed togh-pages)Kept navigable on GitHub
The doc content was already ordinary Markdown with relative
.mdlinks, so it renders on GitHub as-is. To preserve the navigation the VuePress sidebar used to provide:docs/README.mdindex linking English (docs/) and Japanese (docs-ja/).docs/docs/README.mdanddocs/docs-ja/README.md, mirroring the old sidebar.Docs/prose updates
AGENTS.md,dev-docs/README.md, and thedevelopment-workflowskill now describedocs/as plain Markdown rather than a published VuePress site.dev-docs/adr/0005-remove-vuepress-plain-markdown-docs.mdrecording the decision (ADR 0001 is left intact as history).Follow-up (manual — item 3)
Disabling GitHub Pages and deleting the
gh-pagesbranch are repository settings that can't be changed from repo files. A maintainer should:gh-pagesbranch (git push origin --delete gh-pages).Existing deep links to the hosted site will break after Pages is disabled; links from the repo now point at the Markdown files in
docs/.Notes
Source/code changed, so no tests are affected.Co-authored-by: Copilot App 223556219+Copilot@users.noreply.github.com