awesome-readme VS Read the Docs

About user-statistician

The user-statistician GitHub Action can generate an SVG with a detailed summary of your activity on GitHub. It is mentioned in the tools section of the awesome README awesome list. The SVG it generates includes general information about you (e.g., year you joined, number of followers, number you are following, most starred repository, etc), information about your repositories (e.g., numbers of stars and forks, etc), information about your contributions (e.g., numbers of commits, issues, PRs, etc), and the distribution of languages within your public repositories.

If you really want a stellar README.md take a look at some of the examples in awesome-readme for inspiration!

Awesome README - A collection of high-quality READMEs from a variety of projects, organized by topic. https://github.com/matiassingers/awesome-readme

Provide a succinct and comprehensive README: readers of your personal project will always start with the README to know where to begin. The goal of the README is to provide the reader an understanding of the business problem you are trying to solve, how your solution goes about solving it (solution architecture diagram), and how to get started and run your code. There are plenty of great README examples here: https://github.com/matiassingers/awesome-readme

About user-statistician

Recently, the user-statistician GitHub Action was added to the tools section of Awesome README, which is an Awesome List that includes a curated collection of examples of Awesome READMEs from open source projects, as well as tools enabling creating Awesome READMEs. The Awesome README list is a great place to go if you are looking for ideas for how to improve the READMEs of your open source projects. The Awesome README list covers READMEs more generally, but the tools section includes a few tools focused on Profile READMEs, in addition to many tools for project READMEs more generally. The user-statistician GitHub Action is in the Tools Section.

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/