docs: refactor tonbo docs #298
Merged
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
crwen
force-pushed
the
docs
branch
4 times, most recently
from
d6af871 to
f48d8ac
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR largely focuses on enhancing and refactoring the documentation for Tonbo and TonboLite while updating contribution guidelines and CI configurations. Key changes include:
- Adding comprehensive guides for Tonbo API usage, Python/JavaScript bindings, configuration, and advanced usage.
- Introducing detailed documentation for TonboLite usage, installation, and build instructions.
- Updating contribution documentation, SUMMARY, and CI workflow configurations.
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| guide/src/usage/tonbo.md | New documentation for Tonbo API usage with examples and configuration tips. |
| guide/src/usage/python.md | Added documentation for Python binding with examples. |
| guide/src/usage/faq.md | New FAQ section addressing common issues and troubleshooting. |
| guide/src/usage/conf.md | Detailed guide on configuration options for Tonbo. |
| guide/src/usage/advance.md | Documentation for advanced usage including dynamic schema support. |
| guide/src/tonbolite/usage.md | Comprehensive usage guide for TonboLite covering extension usage and SQL integration. |
| guide/src/tonbolite/start.md | "Getting Started" documentation for TonboLite. |
| guide/src/tonbolite/index.md | Introductory page for TonboLite. |
| guide/src/tonbolite/build.md | Build instructions for TonboLite across different platforms. |
| guide/src/start.md | Updated getting started guide for Tonbo with refined installation and usage instructions. |
| guide/src/contribution/testing.md | Added documentation on testing Tonbo. |
| guide/src/contribution/pr.md | New guidelines for submitting pull requests and contribution process. |
| guide/src/contribution/build.md | Expanded build and test instructions for Rust, WASM, Python, and JavaScript. |
| guide/src/SUMMARY.md | Updated SUMMARY to include new sections and reorganized content. |
| guide/book.toml | Added MathJax support and configured the TOC preprocessor in the documentation build. |
| .github/workflows/doc.yml | Updated documentation CI to install mdbook-toc before building the docs. |
Comments suppressed due to low confidence (1)
guide/src/usage/tonbo.md:241
- Typo detected: 'wiil' should be 'will'.
Tonbo wiil use local storage by default. If you want to use S3 storage for specific level, you can use `DbOption::level_path(FsOptions::S3)` ...
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
No description provided.