Move documentation outside of the root directory (#1936)

README.md

@@ -19,7 +19,7 @@ It is generated from the man pages found in this repository.
 The source code of the website itself is on GitHub as well under the repository
 [rgbds-www](https://github.com/gbdev/rgbds-www).
 
-If you want to contribute or maintain RGBDS, read [CONTRIBUTING.md](CONTRIBUTING.md).
+If you want to contribute or maintain RGBDS, please read [our contribution guide](CONTRIBUTING.md).
 If you have questions regarding the code, its organization, etc. you can find the maintainers
 [on the GBDev community channels](https://gbdev.io/chat) or via mail at `rgbds at gbdev dot io`.
 

contrib/checkdiff.bash

@@ -79,15 +79,15 @@ dependency src/gfx/main.cpp        contrib/zsh_compl/_rgbgfx \
 dependency src/gfx/main.cpp        contrib/bash_compl/_rgbgfx.bash \
            "Did the rgbgfx CLI change?"
 
-dependency test/fetch-test-deps.sh CONTRIBUTING.md \
+dependency test/fetch-test-deps.sh docs/CONTRIBUTING.md \
            "Did the test protocol change?"
-dependency test/run-tests.sh       CONTRIBUTING.md \
+dependency test/run-tests.sh       docs/CONTRIBUTING.md \
            "Did the test protocol change?"
-dependency test/asm/test.sh        CONTRIBUTING.md \
+dependency test/asm/test.sh        docs/CONTRIBUTING.md \
            "Did the RGBASM test protocol change?"
-dependency test/link/test.sh       CONTRIBUTING.md \
+dependency test/link/test.sh       docs/CONTRIBUTING.md \
            "Did the RGBLINK test protocol change?"
-dependency test/fix/test.sh        CONTRIBUTING.md \
+dependency test/fix/test.sh        docs/CONTRIBUTING.md \
            "Did the RGBFIX test protocol change?"
-dependency test/gfx/test.sh        CONTRIBUTING.md \
+dependency test/gfx/test.sh        docs/CONTRIBUTING.md \
            "Did the RGBGFX test protocol change?"

docs/ARCHITECTURE.md

@@ -35,6 +35,8 @@ rgbds/
 │   ├── zsh_compl/
 │   │   └── ...
 │   └── ...
+├── docs/
+│   └── ...
 ├── include/
 │   └── ...
 ├── man/
@@ -80,6 +82,12 @@ rgbds/
     Tab completion scripts for use with `bash`. Run them with `source` somewhere in your `.bashrc`, and they should auto-load when you open a shell.
   * **`zsh_compl/`:**  
     Tab completion scripts for use with `zsh`. Put them somewhere in your `fpath`, and they should auto-load when you open a shell.
+- **`docs/`:**  
+  Documentation related to the development and maintenance of RGBDS itself.
+  (The directory's name, as well as some of its file's names, are
+  [recognized by GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)
+  and linked to in parts of its UI.)
+  Documentation for RGBDS itself exists as manual pages in `man/`.
 - **`include/`:**  
   Header files for the respective source files in `src`.
 - **`man/`:**  

docs/CONTRIBUTING.md

@@ -4,7 +4,7 @@ RGBDS was created in the late '90s and has received contributions from several
 developers since then. It wouldn't have been possible to get to this point
 without their work, and it is always open to the contributions of other people.
 
-## Reporting Bugs
+## Reporting bugs
 
 Bug reports are essential to improve RGBDS and they are always welcome. If you
 want to report a bug:
@@ -35,6 +35,9 @@ implement it yourself, you can always contribute to RGBDS with your own code.
 
 ## Contributing code
 
+Thank you! Code contributions are the most appreciated.
+You can find a description of the project's layout in [`ARCHITECTURE.md`](ARCHITECTURE.md).
+
 If you want to contribute with your own code, whether it is to fix a current
 issue or to add something that nobody had requested, you should first consider
 if your change is going to be small (and likely to be accepted as-is) or big
@@ -250,3 +253,11 @@ manually running:
 docker build . --tag ghcr.io/gbdev/rgbds:master
 docker push ghcr.io/gbdev/rgbds:master
 ```
+
+## Publishing a new release
+
+Please refer to [`RELEASE.md`](RELEASE.md).
+
+## Closing remarks
+
+Feel free to add yourself to `CREDITS.md`!