jaculabilis/danbooru
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

21
app/components/README.md Normal file
View File

@@ -0,0 +1,21 @@
# Components
Components are used to encapsulate common UI widgets used throughout the site. This includes things like comments, tag
lists, post thumbnails, paginators, and other things used repeatedly throughout the site. Components encapsulate a
widget's HTML, CSS, and Javascript together so that all the code for a component is in a single place.
This uses the [ViewComponent](https://github.com/github/view_component) library.
Components are similar in concept to React components.
# See also
* [app/views](../views)
* [app/javascript](../javascript)
* [test/components](../../test/components)
# External links
* https://viewcomponent.org
* https://github.com/github/view_component
* https://github.blog/2020-12-15-encapsulating-ruby-on-rails-views/