Repository navigation
docs: add a documentation site published to GitHub Pages - #113
Merged
Merged
Conversation
Move the README reference content into a Hugo site under docs/, served at https://boxboxjason.github.io/achievements/ and built from the same repository so it changes together with the code. - The commands, settings and achievements pages are generated from package.json and the achievement stacking templates (npm run docs:generate). CI runs npm run docs:check, which fails when a generated page is stale. - The getting started walkthrough shown in VS Code is rendered on the site from the same files. - The commands page now lists achievements.statusBarMenu, and the settings page the actual log levels, both missing or wrong in the README. - Package only the walkthrough files and the panel animation from docs/, so the site sources stay out of the VSIX. - Look and feel and the build/check/deploy workflow come from the shared boxboxjason/hugo-theme module and reusable workflow, pinned to the same commit in docs/go.mod and the workflow. The site is deployed from an Actions artifact, there is no gh-pages branch. - Slim the README down to a summary, installation and a link to the docs.
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
Adds a Hugo documentation site under
docs/. It is published to https://boxboxjason.github.io/achievements/ and built from this repository, so the docs change in the same PRs as the code. It uses the same shared theme and workflow as gitlab-sync.scripts/generate-docs.ts(no new dependencies, run with ts-node) generates three pages:package.jsoncontributions.npm run docs:checkruns in thebuildworkflow and fails when a generated page is stale. I mutation-tested it with a changed command title, an added setting and a changed tier count.achievements.statusBarMenu(Quick Menu) and listed the wrong log levels. The generated pages fix both.docs/walkthroughs) is also rendered on the site from the same files, through a smallwalkthroughshortcode.package.jsonfilesnow lists onlydocs/achievements.gifanddocs/walkthroughs, so the site sources stay out of the VSIX. Checked withnpm pack --dry-run.boxboxjason/hugo-theme, pinned to the same commit indocs/go.modand the workflow. The site is deployed from an Actions artifact; there is nogh-pagesbranch.Test plan
npm run check-typesandnpm run lintpass.npm run docs:checkpasses, and fails on each mutation above.--panicOnWarningand was viewed under the/achievements/sub path in light and dark mode, with no 404s.npm testwas not run locally: it downloads VS Code, and the extension sources are unchanged.Unrelated to this PR:
vscecurrently refuses to package because@types/vscode1.138.0 is newer thanengines.vscode^1.134.0, so the release workflow would fail until one of them is changed.