From 22c10941dc5086f6519f9f526348d68700c57e84 Mon Sep 17 00:00:00 2001 From: Jan Tojnar Date: Fri, 8 Jul 2022 21:00:32 +0200 Subject: [PATCH] docs: Update directory structure description (#2906) - The css directory was moved in 1a4c3f4418552de5e2efc514bdd18e1b6da5bc82 --- docs/04_For_Developers/03_Folder_structure.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/04_For_Developers/03_Folder_structure.md b/docs/04_For_Developers/03_Folder_structure.md index 27f905c9..37c59fb0 100644 --- a/docs/04_For_Developers/03_Folder_structure.md +++ b/docs/04_For_Developers/03_Folder_structure.md @@ -2,9 +2,14 @@ The repository contains a few folders that make up **RSS-Bridge**. Here is a bri Folder | Description -------|------------ -[`bridges/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/bridges) | Contains all bridges that are currently supported by **RSS-Bridge**. Each file represents one Bridge that is displayed on the [Welcome screen](../01_General/04_Screenshots.md#welcome-screen) of **RSS-Bridge** -[`caches/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/caches) | Contains all cache types for **RSS-Bridge**. -[`css/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/css) | Contains all [Cascading Style Sheets](https://en.wikipedia.org/wiki/Cascading_Style_Sheets) for **RSS-Bridge** -[`formats/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/formats) | Contains all export formats for **RSS-Bridge**. -[`lib/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/lib) | Contains the core API of **RSS-Bridge**. -[`vendor/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/vendor) | Contains vendor specific files to support **RSS-Bridge**. Development of all files in this folder must be done in the vendor specific repository (not part of **RSS-Bridge**) \ No newline at end of file +[`actions/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/actions) | Contains all “[controllers](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller)” for the web front-end. +[`bridges/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/bridges) | Contains all bridges that are currently supported. Each file represents one Bridge that is displayed on the [Welcome screen](../01_General/04_Screenshots.md#welcome-screen) of **RSS-Bridge** +[`caches/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/caches) | Contains implementation for different cache back-ends supported. +[`contrib/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/contrib) | Contains various helpers for development and release process. +[`docs/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/docs) | Contains this documentation. +[`formats/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/formats) | Contains all export formats. +[`lib/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/lib) | Contains the core API and helper functions. +[`static/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/static) | Contains all static assets for the web front-end, including images, style sheets and JavaScript code. +[`templates/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/templates) | Contains templates for producing the HTML of the web front-end. +[`tests/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/tests) | Contains the test suite and fixtures. +[`vendor/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/vendor) | Contains third-party libraries used by **RSS-Bridge**. Development of all files in this folder must be done in the vendor specific repository (not part of **RSS-Bridge**)