Show HN: Generate docs from your public repos(app.docs.dev)

27 pointsby linktothenewletztes Jahr11 comments

app.docs.dev

Show HN: Generate docs from your public repos

https://app.docs.dev/generate-docs-instantly

Hello HN, I’m Andrew from docs.dev (https://docs.dev/), an AI powered docs assistant. With docs.dev you can generate your docs directly from your codebase, existing docs and other context sources.

We don’t believe AI will replace technical writers—our goal is to make it easier for teams to get a solid first draft that they can review, edit, and improve. Think of it as a head start, not a finished product.

More info on what we’ve built below but we wanted to release a quick, 1 minute, generate docs from your codebase tool. Try it out here: https://app.docs.dev/generate-docs-instantly.

We built this page, so folks could generate some docs easily and quickly on some of their open source projects. It is still new so let us know if there are bugs but feel free to give it a try! It should work on any moderately sized public repo on GitHub.

Why build another docs tool? We believe there are many great tools out there to help teams host their docs and make them look great, but that there aren’t enough tools to help teams manage the content that goes into them. We found that often there’s a disconnect between the devs shipping code and the teams managing the docs, often leading to delays in getting new features out the door or outdated docs. We kept hearing that the only thing worse than no docs is incorrect docs.

So, we built tools to help you manage docs directly from your codebase—no special platforms or vendor lock-in required. With docs.dev you can not only generate first drafts of new docs, but also audit your existing docs in bulk, analyze them for effectiveness, and keep everything up to date as the product changes.

docs.dev can: Work with any markdown-powered framework Generate clean markdown files synced with your GitHub repo Support existing markdown docs, your codebase, and even Slack threads as context

More info at docs.dev (https://docs.dev/) and on our docs page (https://learn.docs.dev/)

We’d love for you to check us out and welcome any feedback, criticism, suggestions, questions, or ideas! Thanks so much for reading!

4 comments

linktothenewletztes Jahr

Also on the team at docs.dev, if anybody runs into issues or it does not work let us know and we will try to fix ASAP.

linktothenewletztes Jahr

There was actually an issue when you login in with github for the first time, but that should be fixed. Sorry if anybody ran into that.

handfuloflightletztes Jahr

Would be useful to see an already generated example without having to go through the process of registration.

dev-docsailetztes Jahr

For sure! Example pr below

https://github.com/generatorlegend/spriteai-dev-docs/pull/5/...

dev-docsailetztes Jahr

Here is one on tensorflow as well:

https://github.com/generatorlegend/tfjs/pull/2/files#diff-a7...

handfuloflightletztes Jahr

Awesome, thank you. So what happens when the repo updates?

Can the docs auto-regenerate, taking into the full context of cascading changes based on a new commit?

I'd pay money for this ability.

linktothenewletztes Jahr

Hey so that is when you would install our GitHub app, which listens for changes on your codebase and similarly opens PRs. Optionally you can use our AI powered markdown editor, to edit and review the markdown in the PRs. Happy to help set up free trial credits for that use-case if you want to reach out.

wbakstletztes Jahr

actually insane you have this domain that's amazing

linktothenewletztes Jahr

Thanks! We got lucky!

ddtaylorletztes Jahr

Is this something my company can use for private repos?

dev-docsailetztes Jahr

We can work with private repos using our GitHub App and VsCode Extension, but the link provided in this post is built more for public repos because we wanted it to be easy for folks to use GitHub Oauth to generate docs while at the same time limiting the permission to only public repos so people are not worried they shared anything sensitive.

Would be happy talk if you want to set up our GitHub app or Vs Code. Only thing I would say is that our tool generate docs for you so I would just make sure wherever you use our tool to generate the docs on your private repos, you make sure that location is also private so you can proof read before publishing it publicly.

Also you can learn more here at: https://learn.docs.dev