[Feature] Add VitePress documentation site with GitHub Pages deployment#2
Merged
Conversation
42-page standalone docs site under site/ covering every public export. Blue brand palette (#0057b7 light / #4d9eff dark), Y.svg logo, local search, version badge, and CI/CD workflow for drsmile444.github.io/grammy-testing/. Bumps version to 0.22.0.
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.
What
Adds a full 42-page standalone documentation site under
site/covering every public export of@grammyjs/testing, deployed automatically tohttps://drsmile444.github.io/grammy-testing/on every push tomain.Why
The library reached v0.22 with a rich two-layer API, 50+ dispatch verbs, and plugin integration patterns — but had no browsable documentation. Users had to read source code to understand the API, slowing adoption.
Changes
Documentation site (
site/)site/.vitepress/config.ts— full VitePress config: dynamic GitHub Pages base URL, nav/sidebar with 6 groups, local search, social links, version badge frompackage.jsonsite/.vitepress/theme/— custom theme extending VitePress default; blue brand palette (#0057b7light /#4d9effdark), both WCAG AA compliantsite/public/logo.svg— Y.svg (grammY Y mark) as site logo and faviconsite/index.md— hero landing page with feature cards and install snippetsite/reference/changelog.md— symlink todocs/CHANGELOG.mdCI/CD
.github/workflows/docs.yml— buildssite/and deploys to GitHub Pages on push tomainor manual dispatchPackage
package.json/jsr.json— version bumped to0.22.0; addeddocs:dev,docs:build,docs:previewscripts; addedvitepressdevDependency.gitignore— addedsite/.vitepress/cacheandsite/.vitepress/disteslint.config.mjs— addedsite/**to ignore patterns (VitePress config files have a separate TS context)Housekeeping
vitepress-siteanddocumentation-contentspecs synced toopenspec/specs/docs/CHANGELOG.mdupdated with 0.22.0 entry