Skip to content

Commit 469180d

Browse files
committed
docs: add comprehensive documentation structure with advanced topics and improved navigation
Documentation improvements: - Add advanced topics documentation (memory management, CMake options, implementation details) - Complete C interface documentation (English & Chinese) - Reorganize documentation file structure for better maintainability UI/UX enhancements: - Implement documentation menu dropdown for improved navigation - Add deep blue gradient background with glassmorphism effect - Show hover indicators without text jumping - Enhance documentation page interactivity Link and routing optimization: - Unify documentation routing (query parameter format ?doc=xxx) - Standardize CLI Tool links - Auto-convert markdown links to HTML navigation - Update all internal navigation links Code cleanup: - Remove redundant root-level documentation files - Reorganize docs/content/ structure File changes: 41 files changed, +3381 -1501 Squashed commits: - docs: add advanced topics documentation and navigation dropdown menu - update minor documentation styling - refactor: reorganize documentation structure and improve navigation
1 parent c454308 commit 469180d

21 files changed

Lines changed: 2721 additions & 841 deletions

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1732,8 +1732,8 @@ jobs:
17321732
17331733
- **Getting Started**: [README.md](https://github.com/wysaid/CameraCapture#readme)
17341734
- **Build & Install**: [BUILD_AND_INSTALL.md](https://github.com/wysaid/CameraCapture/blob/main/BUILD_AND_INSTALL.md)
1735-
- **CLI Tool Guide**: [CLI Documentation](https://ccap.work/cli.html)
1736-
- **C Interface**: [C_Interface.md](https://github.com/wysaid/CameraCapture/blob/main/docs/C_Interface.md)
1735+
- **CLI Tool Guide**: [CLI Documentation](https://ccap.work/documentation.html?doc=cli)
1736+
- **C Interface**: [C Interface Documentation](https://ccap.work/documentation.html?doc=c-interface)
17371737
- **API Reference**: [ccap.work/documentation.html](https://ccap.work/documentation.html)
17381738
17391739
---

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,7 @@ gcc -std=c99 your_code.c -o your_app \
594594
595595
#### Complete Documentation
596596
597-
For detailed usage instructions and examples of the C interface, see: [C Interface Documentation](./docs/C_Interface.md)
597+
For detailed usage instructions and examples of the C interface, see: [C Interface Documentation](./docs/content/c-interface.md)
598598
599599
**Additional C Utilities**: For pixel format string conversion and file I/O functions, also include:
600600

README.zh-CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -511,7 +511,7 @@ gcc -std=c99 your_code.c -o your_app \
511511
512512
#### 完整文档
513513
514-
C 接口的详细使用说明和示例请参见:[C 接口文档](./docs/C_Interface.md)
514+
C 接口的详细使用说明和示例请参见:[C 接口文档](./docs/content/c-interface.md)
515515
516516
**额外的 C 工具函数**:如需像素格式字符串转换和文件 I/O 功能,还需包含:
517517

docs/CMAKE_OPTIONS.md

Lines changed: 0 additions & 167 deletions
This file was deleted.

0 commit comments

Comments
 (0)