8 ms·
Launch HN: Mintlify (YC W22) – Maintainable documentation for software teams
Hi HN, we’re Hahnbee and Han from Mintlify (https://www.mintlify.com/ https://www.mintlify.com/). Mintlify lets software teams easily track and manage documentation. We’re open source and our Github is at https://github.com/mintlify/mintlify https://github.com/mintlify/mintlify.
We worked at software companies in all stages ranging from startups to big tech, and they all had bad documentation, if it even existed at all. We decided to work on this problem and created a VS Code extension called Doc Writer which generated in-line documentation for codebases using Codex from OpenAI. Doc Writer helped people document their code more frequently and still continues to, but there were limitations. We were highly reliant on OpenAI, people didn’t want their proprietary code to be sent into the cloud, and the AI was satisfactory 80% of the time. But after digging deeper into the documentation problem space, we realized that Doc Writer only solved a small part of it.
We quickly learned that (1) the debate about writing documentation vs. having self-documenting code was highly controversial, and (2) entire teams hated writing documentation—not only developers.
We proceeded to interview dozens of startups and learned that the hardest part about documentation is maintaining it. Everybody was developing so quickly that it was difficult for documentation to stay up-to-date. Common problems we heard were that documentation was inconveniently decentralized over multiple platforms, people weren’t aware when important documents changed, and when code changes the related documentation wouldn’t be updated.
The goal of Mintlify is to increase visibility over documentation across your entire team so that you can easily maintain it. Mintlify allows you to centralize your documentation into one searchable place; set up integrations to receive alerts when documents change; implement a CI Check for documentation - connect documentation to code and receive alerts to update your documentation when the code changes.
Other solutions to the problem of documentation maintenance tend to create an editor (e.g. Notion, ReadMe, Archbee, Gitbook). We decided instead to work with teams’ existing documentation stack, because of our belief that maintenance of documentation is the real hard problem in this space. Our software is designed to help documentation owners ensure that content stays in good condition.
Here is our 2 min demo: https://www.loom.com/share/892d08e178144cd89b109f9396e4db98 https://www.loom.com/share/892d08e178144cd89b109f9396e4db98, and you can also try it for yourself: https://www.mintlify.com/create https://www.mintlify.com/create
Ultimately, we want to create a suite of automations that makes maintaining high quality documentation easy. We plan on adding documentation owners and integrations with task management platforms so that tickets can be instantly generated prompting people to update documentation. We believe there is a market for this because of our experience with our earlier Doc Writer product, and because companies like Glean, Gitbook, and Whatfix are all tackling this problem in their own way.
We thank the open source community, our community, and our users for having helped us shape the product to what it is now. We look forward to your feedback, questions, ideas, and suggestions!
- averyyip 4y ago
- zkirby 4y ago
- deleted 4y ago[deleted]
- ushakov 4y agosounds interesting i’m working on Typosaur, which is a spell-checker that can check websites (or any structured document really) for spelling mistakes, grammar and style issues and suggest corrections link: https://typosaur.com/ https://typosaur.com/ maybe you’d be interested in integrating Typosaur-powered spelling suggestions into your offering? if so my e-mail is linked in profile
- hanyiwang 4y agoWe took a look around and am actually really interested! Sending you an email to discuss more. Also, how did you manage to embed any website as an iframe without CORS or CSP issues?
- ushakov 4y agocool! the websites are pre-rendered using headless Chrome the side-effect of this approach is that all the files (like images) are embedded into the HTML and the website also loses interactivity works great for static documentation sites however!
- hanyiwang 4y agoIt does indeed. Would love to jam more about this with you
- irq-1 4y agoRandom thought: maybe you could connect a UI component (or State, or Service call) to a function chain and types used. Then reviewing a document could include links to code changes. It would be difficult to automatically determine which code changes matter. Programmers might be able to @ttribute functions, or include checking tags/links. Anyway, documents that are not one-to-one with a code file seem like the hardest to keep up to update.