Add comprehensive documentation site with VitePress and API docs#39
Merged
Conversation
…egration - Set up VitePress (v1.6.4) with i18n support (English + Korean) - Move English docs from docs/en/ to docs/ root (VitePress convention) - Add home pages for both locales with hero sections - Configure TypeDoc (typedoc-plugin-markdown + typedoc-vitepress-theme) to generate TypeScript API docs as VitePress-compatible markdown - Add build script (scripts/build-docs.sh) that generates: - Rust API docs via cargo doc -> docs/public/rustdoc/ - TypeScript API docs via TypeDoc -> docs/typescript-api/ - Final VitePress static site - Add GitHub Actions workflow for GitHub Pages deployment - Add docs scripts to root package.json (docs:dev, docs:build, docs:preview) - Update .gitignore to exclude generated docs artifacts https://claude.ai/code/session_018C8y4AWmJchWf4uXwZAsq6
- Update site config, landing pages, and all guide/reference introductions - Emphasize dual-runtime identity (Rust + TypeScript) with minimal FFI overhead - Remove Excelize rewrite mentions from architecture docs Signed-off-by: Haze Lee <hazelee@realignist.me>
Nebu1eto
force-pushed
the
claude/sheetkit-docs-site-w3x4e
branch
from
February 10, 2026 12:03
70ec602 to
2156090
Compare
Nebu1eto
marked this pull request as ready for review
February 10, 2026 12:04
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
This PR establishes a complete documentation infrastructure for SheetKit, including a VitePress-based site with bilingual support (English and Korean), automated API documentation generation for both Rust and TypeScript, and CI/CD automation for deployment to GitHub Pages.
Key Changes
Documentation Site Setup
API Documentation Generation
cargo docto generate rustdoc and copy to docs directoryCI/CD Automation
docs.yml) that:cargo docBuild Scripts & Configuration
scripts/build-docs.shfor local documentation building.gitignoreto exclude generated documentation artifactspackage.jsonDocumentation Content
Implementation Details
/sheetkit/base path on GitHub Pages/ko/) localescargo doctoolinghttps://claude.ai/code/session_018C8y4AWmJchWf4uXwZAsq6