Skip to content

feat(docs): VitePress documentation site for GitHub Pages#88

Merged
setkyar merged 1 commit into
mainfrom
feat/docs-website
Jun 27, 2026
Merged

feat(docs): VitePress documentation site for GitHub Pages#88
setkyar merged 1 commit into
mainfrom
feat/docs-website

Conversation

@setkyar

@setkyar setkyar commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Adds a multilingual (14-language) VitePress documentation site, deployed to
https://ygncode.github.io/pi-web/ via GitHub Actions.

What's included

  • Generator (scripts/build_site.py): assembles the VitePress srcDir from user-docs/ + hero.json, strips GitHub-only nav blocks, rewrites asset/README links, generates per-locale sidebars and the language switcher.
  • Hero translations: folded into build_userdocs.py (pi / deepseek-v4-pro), committed as user-docs/<lang>/hero.json.
  • Theme: matches the app's 4 palettes (dark/light/nord/dracula, dracula default) with a nav theme switcher + GitHub "Star" CTA.
  • Hero: demo GIF (desktop + iOS, 3×) with caption; brand logo + favicon.
  • SEO: per-page OpenGraph/Twitter/canonical tags, sitemap, 1200×630 OG image.
  • CI/CD: .github/workflows/docs.yml deploys on push to main; make docs / make docs-dev.

Notes

  • Docs-only change; no Go or web/ frontend code touched.
  • Generated dirs (website/src, dist, node_modules, locales.generated.json) are gitignored.
  • Deploy requires GitHub Pages Source = "GitHub Actions" (one-time toggle).

Multilingual (14 languages) docs site built from user-docs/, deployed to
https://ygncode.github.io/pi-web/ via GitHub Actions.

- scripts/build_site.py assembles the VitePress srcDir from user-docs/ +
  hero.json, strips GitHub-only nav blocks, rewrites asset/README links,
  and generates per-locale sidebars + language switcher.
- Hero translations folded into build_userdocs.py (pi/deepseek-v4-pro),
  output committed as user-docs/<lang>/hero.json.
- Custom theme matching the app's 4 palettes (dark/light/nord/dracula,
  dracula default) with a nav theme switcher + GitHub "Star" CTA.
- Hero demo GIF (desktop + iOS, 3x) with caption, brand logo/favicon.
- SEO: per-page OpenGraph/Twitter/canonical tags, sitemap, 1200x630 OG image.
- .github/workflows/docs.yml deploys on push to main; make docs/docs-dev.
@setkyar setkyar merged commit 03b8d05 into main Jun 27, 2026
5 checks passed
@setkyar setkyar deleted the feat/docs-website branch June 27, 2026 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant