Skip to content
@askmanu

askmanu

Building documentation for every code base

Always up to date documentation

askmanu is the AI copilot that has one job: keeping your documentation up to date.

🚀 How it works

  1. Install the github app
  2. askmanu creates a PR with new docs
  3. PR gets reviewed + merged
  4. askmanu goes to step 2

✨ Pro-active PRs

askmanu pro-actively looks at the project the repo contains and proposes new documentation files.

It follows best practices to make the repo if fully documented and easy to understand.

askmanu follows the Diataxis framework to make sure the documentation is the most helpful it can be.

The app creates a PR with the proposed changes and as soon as that gets merged, it starts working on the next one.

No need to create issues, write description or assign them to the askmanu bot.

📝 Types of documentation

It proposes 3 different types of updates:

1. New documentation file

Depending on what's currently missing in the repo, the app proposes new files that cover important topics: how to get started, how to install the SDK, examples, the architecture, etc.

These files usually live in the /docs folder.

2. Updates to existing files

If current doc files are not doing a good job at explaining a specific subject, askmanu will expand it into a full document.

3. Reference documentation

In most cases, inline docs is the most helpful thing.

askmanu has a special focus for adding reference docs to make the code base easier to understand, search and manage.

🔒 Privacy

askmanu doesn't store your code. We read it from github every time we process it. We only share the code with the model provider according to our Privacy Policy

📌 Examples

Some repositories that use askmanu for their docs:

📸 Screenshots

Image

🪙 Pricing

askmanu is FREE for open source projects.

If you want to adopt it for your company schedule a meeting to talk to the team.

Popular repositories Loading

  1. docs docs Public

    MDX

  2. .github .github Public

Repositories

Showing 2 of 2 repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…