What are Repo Wiki Files?
Repo Wiki Files are documentation files stored inside a repository’s wiki system. They are usually written in Markdown (.md) or reStructuredText (.rst) and serve as a knowledge base or technical documentation for the project.
They provide a space to explain:
-
Project overview
-
Setup instructions
-
API references
-
Tutorials and guides
-
Contribution rules
In simple terms, repo wiki files act like a mini documentation site attached to your repository.
How are they Generated?
In Qoder, Repo Wiki Files are typically generated in one of two ways:
-
Manual Creation – You can directly add
.mdfiles in the wiki section of your repo. -
Automatic Generation – Qoder can generate wiki pages automatically from:
-
README files
-
Code comments / docstrings
-
Predefined templates (like API docs, changelogs, or FAQs)
-
Imported external documentation
-
This automation helps keep documentation consistent and always in sync with the codebase.
How can they be Used in Qoder?
Repo Wiki Files in Qoder can be used for:
-
Centralized Documentation – Keeping project knowledge in one place.
-
Team Collaboration – Multiple developers can update wiki pages just like code.
-
Version Control – Each change in the wiki is tracked in Git, so history is preserved.
-
Integration – Qoder can link wiki files with issues, pull requests, or specific code modules.
-
Publishing – Wiki pages can be exported or published as a documentation site for end-users.
In short:
Repo Wiki Files in Qoder are structured documentation pages, generated automatically, and used for maintaining project knowledge, team collaboration, and publishing documentation.