slate VS Read the Docs

Slate (Free)

https://github.com/slatedocs/slate this ! Big company use it ( stripe etc )

The second most common question being "What framework does Stripe use to build their documentation?" and the answer has unfortunately always been "They use a custom setup they built themselves and isn't available." － so then Slate gets brought up as a suitable replacement

DocuAPI is a multilingual API documentation theme for Hugo created and maintained by Bjørn Erik Pedersen, the lead maintainer and co-creator of Hugo itself. It’s built on top of the Slate API docs generator, which itself was inspired by Stripe’s and PayPal’s API docs. The JavaScript section of DocuAPI has been rewritten from Jquery to AlpineJS.​​​​​​

I've used Slate to document APIs which similarly will produce a local website. You can host that privately or there's built in support to push to github pages if you're hosting it in a github repo. The documentation itself is all written in markdown and managed separate from your API code.

Clone/inspired by stripe docs: https://github.com/slatedocs/slate

If you are going to use Slate from the console you need to install it, along with all its prerequisites, as described here. In Ubuntu you can execute the commands:

Slate - API Generator

I went to https://readthedocs.org/ and redirected me to https://about.readthedocs.com/?ref=readthedocs.org which looks proprietary now, with pricing and such.

Is it the end of this project, as we know it?

Can someone enlighten me please?

First things first, sign up on Read the Docs and connect your GitHub account. This allows Read the Docs to access your repositories.

ReadTheDocs - ReadTheDocs hosts documentation for many Django packages. It provides easy access to comprehensive documentation, including installation instructions, configuration guides, and usage examples.

fixes are here: https://github.com/readthedocs/readthedocs.org/issues/10290

Read the Docs offers free hosting of Sphinx-based documentation. I recommend setting up a basic documentation very early so that you can easily add material when you have something to write about. I also recommend studying The Grand Unified Theory of Documentation, but don't overthink it.

ReadTheDocs: An open-source platform for creating and hosting documentation, with support for multiple programming languages and integration with version control systems.

Well, by now I really invite all the readers to join and read more about the datadelivery Terraform module. There is a huge documentation page hosted on readthedocs with many useful information about how this project can help users on their analytics journey in AWS.

ReadTheDocs is a free way to host your open-source documentation.

They are using this infrastructure as the moat. ReadTheDocs is also doing the same thing.

Deploy if you dare: https://github.com/readthedocs/readthedocs.org

That "/*/tree" rule means that search engine crawlers are allowed to hit the README file of a repo but effectively NONE of the other files in it.

Which means that if you keep your project documentation on GitHub in a docs/ folder it won't be indexed!

You need to publish it to a separate site via GitHub Pages, or use https://readthedocs.org/