Skip to content

Move docs site readme content into actual docs

Marcel Amirault requested to merge docs-site-docs into main

In multiple issues and discussions recently, including in technical-writing#472 (comment 653135132), we've brought up the need to have better documentation for how to maintain the docs site itself. This made me think of #1046 (closed) again, and how a somewhat small change could perhaps make it much easier to add the documentation we need.

Some examples of issues where it's not clear where to add the docs, or not docs exist:

This MR takes all the content we have in our big README.md and just moves it into a /doc directory. It also:

  • Adds a few introductory lines to pages aren't empty at the top.
  • Updates all the links as needed.

It is not published anywhere, but it does give us better places to add the information that needed a place to go. It should help answer the question: "Should I put this in the docs site README.md or not?", by changing it to "Is this docs site information for the maintenance, development, setup, or raketasks page?".

Edited by Marcel Amirault

Merge request reports