docs: document config/ and some directories in app/.

* Add README files to several directories in app/ giving a brief
  overview of some parts of Danbooru's architecture.
* Add documentation for files in config/.
This commit is contained in:
evazion
2021-06-26 22:47:54 -05:00
parent b9068b8a3e
commit 0563ca3001
28 changed files with 534 additions and 8 deletions

14
config/README.md Normal file
View File

@@ -0,0 +1,14 @@
# Config
This directory contains configuration files for Danbooru.
To configure your Danbooru instance, copy [danbooru_default_config.rb](./danbooru_default_config.rb)
to [danbooru_local_config.rb](./danbooru_local_config.rb) and edit it. See
[danbooru_default_config.rb](./danbooru_default_config.rb) for details.
The only file here that end users need to be concerned about is [danbooru_default_config.rb](./danbooru_default_config.rb).
The rest of the files here are internal Rails-related configuration files that end users shouldn't need to edit.
# External links
* https://guides.rubyonrails.org/configuring.html