readthedocs.org
readthedocs.org copied to clipboard
Docs: write a "How to do docs-as-code with Read the Docs" guide
It would be good to mention the "Documentation As Code" concept in our documentation more.
There are some good websites covering these topics already that we can use as a guide for our how-to:
- https://docs-as-co.de/
- https://www.docslikecode.com/
The goal here is to rank for folks looking for "docs as code" and "docs like code" for their docs tooling. We've been doing this approach since the beginning, but don't rank well for it since we don't use the terms on our pages. (/cc @benjaoming for a good example of how good content doesn't inherently lead to good SEO).
This is a really good idea! I have experience where people's entry-point wasn't about Read the Docs or Sphinx or API docs... but "Documentation as Code" - I think it has a very strong position in the minds of people who are used to writing documentation that isn't code, like Confluence, Word, Wikis etc.. stuff that's database-driven.
This is also relevant for landing pages.
We've publish this content at https://about.readthedocs.com/docs-as-code/