Skip to content

Add comprehensive documentation site with VitePress and API docs#39

Merged
Nebu1eto merged 2 commits into
mainfrom
claude/sheetkit-docs-site-w3x4e
Feb 10, 2026
Merged

Add comprehensive documentation site with VitePress and API docs#39
Nebu1eto merged 2 commits into
mainfrom
claude/sheetkit-docs-site-w3x4e

Conversation

@Nebu1eto

Copy link
Copy Markdown
Owner

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

    • Added VitePress configuration with shared, English, and Korean locale configs
    • Created home pages for both English and Korean with feature highlights
    • Organized documentation structure with guides, API references, and architecture docs
    • Configured navigation, sidebars, and edit links pointing to GitHub
  • API Documentation Generation

    • Added TypeDoc configuration to automatically generate TypeScript API docs from source
    • Integrated TypeDoc VitePress theme for consistent styling
    • Configured Rust cargo doc to generate rustdoc and copy to docs directory
    • Created helper function to normalize TypeDoc sidebar links for VitePress
  • CI/CD Automation

    • Added GitHub Actions workflow (docs.yml) that:
      • Builds Rust API docs with cargo doc
      • Generates TypeScript API docs with TypeDoc
      • Builds VitePress site
      • Deploys to GitHub Pages automatically on pushes to main
    • Workflow includes proper permissions, concurrency control, and artifact management
  • Build Scripts & Configuration

    • Created scripts/build-docs.sh for local documentation building
    • Added npm scripts for documentation development and building
    • Updated .gitignore to exclude generated documentation artifacts
    • Added TypeDoc, VitePress, and related dependencies to package.json
  • Documentation Content

    • Organized existing docs into proper directory structure
    • Created bilingual home pages with hero sections and feature highlights
    • Set up sidebar navigation for guides, API references, and TypeScript API docs

Implementation Details

  • Documentation is deployed to /sheetkit/ base path on GitHub Pages
  • Bilingual support with English (root) and Korean (/ko/) locales
  • TypeScript API docs are automatically generated from JSDoc comments
  • Rust docs are generated via standard cargo doc tooling
  • Local search functionality enabled via VitePress local search provider
  • Clean URLs and last updated timestamps configured for better UX

https://claude.ai/code/session_018C8y4AWmJchWf4uXwZAsq6

claude and others added 2 commits February 10, 2026 20:53
…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
Nebu1eto force-pushed the claude/sheetkit-docs-site-w3x4e branch from 70ec602 to 2156090 Compare February 10, 2026 12:03
@Nebu1eto
Nebu1eto marked this pull request as ready for review February 10, 2026 12:04
@Nebu1eto
Nebu1eto merged commit b41206f into main Feb 10, 2026
2 checks passed
@Nebu1eto
Nebu1eto deleted the claude/sheetkit-docs-site-w3x4e branch February 10, 2026 12:05
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.

2 participants