Chapter 04
The code wiki
For every connected repository, Vyazen generates a wiki — a set of documentation pages written from your code, plus a chat that answers questions grounded in your repo.
What the wiki is
After a repository is indexed, Vyazen produces a wiki with pages like:
- Overview — what the project is and how it's organized.
- Getting Started — how to run the project locally.
- Architecture — the main components and how they fit.
- Glossary — key terms in the codebase.
- Patterns — recurring approaches in the code.
- Conventions — how the team writes code (naming, structure).
- Decisions — notable design choices.
- Changelog — recent changes.
- Maintainers — who owns what.
The wiki is auto-generated — you don't write it. It's a fast way to orient yourself (or a teammate, or the agent) in a repo.
Browsing the wiki
Open the wiki from the repository view. A tree on the left lists the pages; select one to read it on the right. Navigate the tree to move between pages.
Chatting with the wiki
The wiki has a chat box. Ask a question about the repository — "How does authentication work?", "Where is the billing module?" — and Vyazen answers using the code graph and wiki content, not generic knowledge. Answers point at the relevant files and symbols.
suggestion
When the wiki regenerates
The wiki is tied to the index. When you refresh a repository (or it re-indexes after significant changes), the wiki regenerates to reflect the current code. If a page looks out of date, refresh the repository and revisit.
Limitations
- The wiki is generated, so it can lag the very latest code between re-indexes. For critical decisions, verify against the source.
- Chat answers are only as good as the index — if a topic isn't well-covered in your code, the answer may be thin.
- It's a navigation and orientation aid, not a replacement for reading the code on a deep change.