docs: add comprehensive WeKnora documentation - #2350
Merged
lyingbug merged 2 commits intoAug 6, 2026
Conversation
This commit introduces a complete set of documentation for WeKnora, organized into six main sections: Getting Started, Architecture, Features, API Reference, Clients, and Development Guide. Key highlights include: - Detailed installation instructions and quick start guides. - In-depth architectural overview and backend design documentation. - Comprehensive feature descriptions, including multi-tenant support, document parsing, and agent capabilities. - API reference covering approximately 360 endpoints with usage examples. - Client documentation for various interfaces including web, CLI, and SDK. This documentation aims to facilitate user onboarding and provide a thorough understanding of the WeKnora system.
This commit sets up a new documentation site for WeKnora using VitePress. Key additions include: - A structured `.gitignore` to manage ignored files. - An `index.md` file serving as the landing page with a clear title and layout. - A `package.json` and `package-lock.json` to manage dependencies, including VitePress and related plugins. - Thematic styles and components for a cohesive user experience, including a custom landing page and zoom functionality for diagrams. - A README update to guide users on local development and site structure. This foundational setup aims to enhance user onboarding and provide comprehensive documentation for the WeKnora system.
lyingbug
pushed a commit
to lyingbug/WeKnora
that referenced
this pull request
Aug 5, 2026
Bring the documentation site from Tencent#2350 onto current main as the starting point for the refresh.
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
1 participant
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
website-docs/完整官方文档（46 篇，约 16,000 行），按「入门 → 架构 → 功能 → API → 客户端 → 开发」六部分组织Test plan
website-docs/README.md目录链接均可正常跳转