📝 docs: add comprehensive GitBook documentation system #27
Conversation
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
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
Collaborator
Author
|
文档施工中，现有内容大多为AI生成，不可轻信！ |
WitMiao
force-pushed
the
feat/gitbook
branch
4 times, most recently
from
c0c33e9 to
022cb04
Compare
WitMiao
force-pushed
the
feat/gitbook
branch
3 times, most recently
from
1ab5179 to
c5a3ee3
Compare
WitMiao
force-pushed
the
feat/gitbook
branch
3 times, most recently
from
c78d671 to
220a560
Compare
WitMiao
force-pushed
the
feat/gitbook
branch
2 times, most recently
from
5eef590 to
1b197a3
Compare
WitMiao
force-pushed
the
feat/gitbook
branch
2 times, most recently
from
9ea09e1 to
5f87da7
Compare
WitMiao
force-pushed
the
feat/gitbook
branch
2 times, most recently
from
0177342 to
c3fc887
Compare
WitMiao
force-pushed
the
feat/gitbook
branch
5 times, most recently
from
8dbc3a3 to
e812eef
Compare
- Add complete GitBook configuration (.gitbook.yaml) - Create bilingual documentation structure (zh-CN/en) - Add main documentation sections: - Getting Started (installation, first run) - Advanced Guide (configuration, workflows, troubleshooting) - Claude Code Tips (best practices, MCP integration, templates) - Development (contributing, architecture, API reference) - Support multiple output formats (web, PDF) - Enable Google Analytics integration - Configure git sync for automatic updates 🚀 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Introduced new GitBook documentation files for both English and Chinese, including installation guides, quick start examples, and advanced configuration topics. - Deleted outdated README and SUMMARY files for English and Chinese versions to streamline content. - Added comprehensive sections on workflows, best practices, and features to improve user guidance. - Implemented a bilingual structure to support wider accessibility and usability. This update aims to provide a more organized and user-friendly documentation experience for ZCF users.
…nsive guides - Restructure getting-started section for better clarity - Merge installation, first-run, and quickstart into unified guide - Remove redundant separate files - Update SUMMARY.md to reflect simplified structure - Massively enhance documentation content across all sections - Advanced: Add detailed guides for API providers, configuration, i18n, templates, troubleshooting - Best practices: Expand output styles, tips, and worktree workflows - CLI: Complete comprehensive command references for all tools - Development: Detail architecture, contributing guidelines, and testing - Features: Add in-depth explanations for all ZCF features - Workflows: Provide complete workflow documentation with examples - Documentation improvements include: - Detailed examples and code snippets for all features - Comprehensive troubleshooting sections - Best practice recommendations and usage patterns - Multi-platform support details (Windows/macOS/Linux/WSL/Termux) - Complete API reference and configuration options - Step-by-step guides for common scenarios This comprehensive update transforms the documentation from basic outlines to complete user guides, significantly improving user experience and onboarding.
…tion - Updated .gitignore to include VitePress cache files. - Added "vitepress" to cspell.json for spell checking. - Introduced new scripts in package.json for previewing documentation. - Created GitHub Actions workflow for deploying documentation to GitHub Pages. - Added comprehensive VitePress configuration and theme files. - Expanded documentation with new sections in multiple languages (English, Chinese, Japanese). - Removed outdated README and SUMMARY files to streamline content. This update significantly improves the documentation experience and supports a bilingual structure for better accessibility.
Synchronized the following changes from main branch to VitePress docs: - Added GLM CODING PLAN sponsorship information to documentation homepage (zh-CN and en) - Added Linux sudo support notes to installation guide (zh-CN and en) - Updated documentation to reflect v3.3.3 features Changes include: - GLM CODING PLAN sponsor section with discount links - Linux automatic sudo detection and usage instructions - Enhanced installation guide with permission handling notes Related commits from main: - 83c8fc7: docs: update README files to include GLM CODING PLAN sponsorship details - 5102075: feat: enhance installation process with sudo support for Cometix and CCR - cee792b: feat(linux): add sudo support for global npm installations
WitMiao
force-pushed
the
feat/gitbook
branch
from
fa6bd32 to
85c5e95
Compare
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.
🚀 Generated with Claude Code
Co-Authored-By: Claude [email protected]