Repo Wiki automatically generates structured documentation for your project and continuously tracks changes to both your code and the documentation.
When you look up information, request code explanations, or add new features during development, Repo Wiki deeply analyzes your project's structure and code implementation. It combines this analysis with contextual information to provide more accurate, detailed answers and documentation support, giving the agent a deeper understanding of your codebase.
This feature is currently in Beta and includes a free usage quota. Once you exhaust the quota, you cannot use the feature again until it is generally available.
| Applicable editions | Enterprise Edition |
|---|
Limitations
-
Up to 10,000 files per project.
If your project exceeds 10,000 files, we recommend excluding non-essential paths in LINGMA Settings → Codebase Indexing → Index Exclusion.
-
Full generation supports all repositories. Incremental updates require a Git repository with at least one commit.
Wiki generation
The Wiki in your repository is not static---it stays in sync with your code.
Understanding these triggers helps you maintain an up-to-date Wiki.
-
Initial wiki generation
When you first open a project, no Wiki exists by default. You can generate one from scratch with a single click.
Typical generation time: Approximately 120 minutes for a repository with 4,000 files.
In the REPO WIKI (BETA) panel on the left, select your target language (for example, English ) from the language dropdown menu, and then click the purple Generate button.
-
Code change detection
After the initial generation, the system continuously monitors your repository for code changes.
The system detects inconsistencies when you modify indexed content. When an inconsistency is found, click Update to regenerate only the affected parts.
To prevent generation errors, keep each code change under 10,000 lines.
markdown
# Core Module
<cite>
**Files referenced in this document**
- src/app.js
- src/index.js
- src/utils.js
- README.md
</cite>
## Table of Contents
1. Introduction
2. Project Structure
3. Core Components
4. Architecture Overview
5. Detailed Component Analysis
6. Dependency Analysis
7. Performance Considerations
8. Troubleshooting Guide
9. Conclusion
## Introduction
WikiTest is a simple JavaScript application that demonstrates basic modular design and object-oriented programming concepts. The project consists of three core modules: an application module, a utility module, and a main entry module. Each module has clear responsibilities, reflecting the single-responsibility principle and best practices for modular development.
The main goals of this project are to demonstrate:
- Modular JavaScript development patterns
- The application of object-oriented programming in both front-end and back-end environments
- Basic data management and manipulation patterns
- Simple user interface interactions
## Project Structure
The project uses a flat file structure, with all source code located in the `src` directory:
graph TB
subgraph "Project Root"
Root[Project Root]
subgraph "src Directory"
App[src/app.js<br/>Application Module]
Index[src/index.js<br/>Main Entry Module]
Utils[src/utils.js<br/>Utility Module]
end
subgraph "Documentation"
end
end
-
Git directory sync
If you edit a Markdown file directly in your Git directory, the system detects a mismatch between the Git content and the Wiki. You can click Sync to update the Wiki from your Git directory.
Do not edit the repowiki/.../meta file in your Git directory, as this may prevent the Wiki from loading. This file is automatically managed by the system.
Customize wiki generation
Repo Wiki produces living documentation, not a static, read-only artifact. You can steer the generation process with a configuration file or edit the content at any time after its creation. The system recognizes and preserves your team's modifications as valuable knowledge. It does not overwrite these changes during automatic updates but instead syncs them back to the corresponding knowledge card, effectively integrating human expertise into your knowledge base.
/knowledge command
In the chat box, enter /knowledge to customize the Repo Wiki and its knowledge cards.
| Actions | Description |
|---|
| Generate | Generates the initial wiki or knowledge cards for a project. |
| Modify | Makes partial modifications to existing knowledge content. |
| Supplement | Adds new content to existing knowledge. |
| Rewrite | Completely rewrites a knowledge page or card. |
-
In the input box, type
/knowledge.
-
Enter a command describing the desired changes.
-
Optionally, upload local files (such as design or API documents) as a reference.
-
The agent modifies the corresponding knowledge content based on your instructions.
The system tags and protects manually modified content. Subsequent automatic updates do not overwrite this content, ensuring that your team's knowledge revisions become permanent assets.
wiki_plan.yaml --- Pre-generation configuration
By using a configuration file, you can provide guidance before wiki generation to control its direction and scope.
File location:
themes
<Project Root>/.qoder/repowiki/wiki_plan.yaml
themes
version: 1
repowiki:
template: "" # Pre-built template (architecture / product_requirement)
notes: # Injects guidance prompts for the planning phase
- text: "Prompt text"
author: "Author's name"
documents: # Allowlist of pages (if provided, generation strictly follows this list)
- title: "Page title"
goal: "The writing objective for this page"
parent: "" # Optional, parent page title
hints: "" # Optional, additional writing hints
knowledgecard:
notes: # Injects guidance prompts for the knowledge card planning phase
- text: "Prompt text"
scope:
include: [] # File allowlist (.gitignore syntax)
exclude: [] # File blocklist (.gitignore syntax)
| Parameter | Description |
|---|
repowiki.template | A pre-built template. Valid values are architecture for a comprehensive technical architecture analysis, or product_requirement to format output based on product requirements. |
repowiki.notes | Guidance prompts used during the planning phase to direct the AI's focus. |
repowiki.documents | An allowlist of pages. When provided, the system generates only the pages specified in this list. |
knowledgecard.notes | Guidance prompts for knowledge cards, which influence how modules are defined and partitioned. |
scope.include / exclude | Controls which files are visible during generation. |
themes
version: 1
repowiki:
notes:
- text: "The documentation should focus on business processes rather than code details, targeting new engineers."
documents:
- title: "System Architecture Overview"
goal: "Describe the overall system architecture, core modules, and their interactions."
- title: "Order System"
goal: "Explain the complete lifecycle of an order."
parent: "System Architecture Overview"
knowledgecard:
notes:
- text: "Focus on modeling the two core subsystems: payment and order."
scope:
include:
- "src/**"
exclude:
- "**/test/**"
After you modify wiki_plan.yaml, you must manually trigger Generate or Regenerate for the changes to take effect.
Wiki sharing
You can share a Wiki to distribute knowledge efficiently within your team. When you generate a Wiki locally, the system automatically creates a dedicated directory in your code repository: .qoder/repowiki.
This directory is organized by language and module. For example, under .qoder/repowiki/en/content/, the system generates corresponding .md files for each module, such as Core Module.md, User Service Module.md, and Main Entry Module.md.
You can commit this directory and push it to a remote branch. Team members can then pull the generated Wiki content by using git pull. No extra configuration is required.
Multilingual support
The Wiki system provides multilingual support , allowing you to select a preferred language when generating a Wiki. Currently, English and Chinese are supported. Based on your language choice, the system automatically creates a separate directory in your Git repository for each selected language, such as .qoder/repowiki/zh/ and .qoder/repowiki/en/.
Use cases
-
Architecture and implementation questions
With its pre-built architectural knowledge, the agent can quickly answer questions like "How is X implemented?" or "Which services depend on this module?" with minimal need to call external tools.
-
Agent-driven development tasks
When the context window is limited, Repo Wiki accelerates code discovery for tasks such as:
-
Adding new features
-
Fixing bugs
File location:
Share this file with your team through Git commits.
Configuration structure:
Key configuration parameters: