Overview
Wiki is your single portal for searching, viewing, and sharing all your internal developer documentation. You can access documentation at project, module, and file levels for all connected Git repositories you have permission to view.
Documentation generated by Komment includes usage guides, architecture diagrams, dependency charts, in-depth code explanations, and ready-to-use example snippets.
Documentation in your Wiki automatically updates as Pipelines run across your repositories and Komment discovers new insights about your codebase.
Access Wiki via the top item in your dashboard's main menu.
The landing page of Wiki displays all your connected repositories. If you're part of an organization or a collaborator on a repository on its originating git platform, you'll automatically have access to all documentation associated with that repository.
Learn more about the various types of docs that Komment produces in the Documentation Types section.
Accessing Docs
- Select the repository you want to view documentation for by clicking on it in the drop-down menu. To find a specific repo quickly, use the search box in the drop-down menu to filter repositories by name.
- With the repository opened, select a file from the list on the left to view its documentation. Your selected file will be highlighted in green. Use the dropdown element above the file list to easily switch between branches in your repository.
- Wiki displays the documentation for your chosen file. A handy estimate of the page's reading time is displayed for your convenience. Each page also features a button to view the file in its original git repository.
The URL in your browser's address bar uniquely corresponds to a specific file, enabling you to share it with colleagues or access the file directly without navigating through multiple pages.
- For supported files that haven't been documented yet, you can instantly trigger a documentation run by clicking the Process button.
- Documentation within your Wiki stays synchronized with your code through regularly scheduled pipelines. Additionally, you can also use the Reprocess button to manually refresh your documentation whenever needed.
Clicking Reprocess will regenerate the entire file's documentation from scratch. If you'd like only selected portions of your file to be re-documented, please message us on Discord about this feature request—we'll prioritize it on our roadmap!