Skip to main content

​
About

askmanu can update and generate new documentation for your repositories.

​
How it works

The Github app listens to code changes and then decides what documentation needs to be created. For example, to create reference docs we parse every file and save stats about how well the file is documented. We then go through each of them and pick a handful that will be updated in the next batch. After we generate the docs and all checks pass, we open a PR with the changes. You don’t need to ask manu to update the docs. It pro-actively does that for you. The documentation feature works as one active PR at a time. As soon as the PR gets merged, we start working on the next batch of files. Note: You own all the documentation created by askmanu, we do not host or gatekeep the docs.

​
Types of documentation

There are the 3 types of documentation changes that askmanu proposes to your project:

​
New documentation files

Depending on what’s currently missing in your project, askmanu proposes new files that cover important topics: how to get started, how to install the SDK, examples, the architecture, etc. These type of documentation includes any types of guides, walk throughs and explanations that help the dev team (or AI coding agents) understand the code base better. These are usually formatted in markdown and can leave in the /docs folder. For example, this is an example of a documentation structure for HuggingFace’s Accelerate project: Example of reference docs After installing the Github app, askmanu indexes the existing documentation and looks for ways to improve it. These can be updating existing files or creating new ones. Once those are found, it creates a PR with the updates. After the PR gets merged, the app continues the process looking for new improvements.

​
Updates to existing files

Sometimes the project might contain a stub for a nice to have documentation that no one had time to finish. askmanu can see doc files are not fully finished and proposes changes to make the document fully featured.

​
Reference

Reference documentation is an essential component of a project’s documentation and forms a strong foundation with which you can build better docs. Reference docs are located directly in the code and explains the inputs / outputs of methods, what it does and sometimes even how to use it. Example of reference docs Example of reference docs After installing the Github App, askmanu indexes your whole code base to detect the files that need new documentation.
askmanu never saves the content of the code files. We pull the content from the repository on an as-needed basis. Check our Privacy policy

​
Try it out

Try out the Github app completely free for open source projects: askmanu.