Skip to content

Commit 8c4dc56

Browse files
committed
complete the folder section of readme
1 parent 4d9ebeb commit 8c4dc56

File tree

1 file changed

+31
-23
lines changed

1 file changed

+31
-23
lines changed

README.md

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,40 +18,48 @@ Content is released under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.
1818

1919
## Folder Structure
2020

21-
```.devcontainer``` This folder contains configuration files (like devcontainer.json) that define a <strong>developement environment</strong> for the project.
22-
It helps set up a consistent workspace for developers, ensuring everyone works with the same tools, settings and dependencies, regardless
23-
of their local set up.
21+
```.devcontainer``` This folder contains configuration files (like devcontainer.json) that define a <strong>development environment</strong> for the project.
22+
It helps set up a consistent workspace for developers, ensuring everyone works with the same tools, settings, and dependencies, regardless
23+
of their local setup.
2424

25-
```.github``` This folder is used to store GitHub-specifc configuration files for the repository. It helps manage automation, workflows, and guidelines
26-
for contribtors.
25+
```.github``` This folder is used to store GitHub-specific configuration files for the repository. It helps manage automation, workflows, and guidelines
26+
for contributors.
2727

28-
```_articles``` This folder contains all the written content (articles) for this project, organized by language and topic. These articles provide
29-
helpful guidance, best practices, and insights about contributing to open source projects.
28+
```_articles``` This folder contains all the written content (articles) for this project, organized by language and topic. These articles provide
29+
helpful guidance, best practices, and insights about contributing to open source projects.
3030

31-
```_data``` This folder contains data files (in formats like YAML) used to store structured information, like site settings, translations,
32-
or metadata. The repository reads these files to dynamically generate parts of the website, such as menus, translations or lists. The folder is important
33-
because it seperates content from code, making it easier to update data without changing the code itself
31+
```_data``` This folder contains data files (in formats like YAML) used to store structured information, such as site settings, translations,
32+
or metadata. The repository reads these files to dynamically generate parts of the website, such as menus, translations, or lists. The folder is important
33+
because it separates content from code, making it easier to update data without changing the code itself.
3434

35-
```_includes``` This folder contains reusable chunks of HTML code, like headers, footers, or components that appear on multiple pages.
36-
The files within this folder are inserted into larger templates or pages, reducing repetition and keeping the code organized. This folder
37-
ensures consistency across the site and makes it easy to update shared elements in one place instead of multiple files.
35+
```_includes```
36+
This folder contains reusable chunks of HTML code, like headers, footers, or components that appear on multiple pages.
37+
The files within this folder are inserted into larger templates or pages, reducing repetition and keeping the code organized. This folder
38+
ensures consistency across the site and makes it easy to update shared elements in one place instead of multiple files.
3839

39-
```_layouts``` This folder contains layouts templates (files) for the site, each file in the folder is a template for a page on the application.
40-
The layout templates in this folder act like blueprints, they determing where certain parts of the page goes and storing all the templates in this folder allows
41-
for components to be reused across multiple pages this helps to keep the site consistent and easier to maintain.
40+
```_layouts```
41+
This folder contains layout templates (files) for the site. Each file in the folder is a template for a page on the application.
42+
The layout templates in this folder act like blueprints: they determine where certain parts of the page go. Storing all the templates in this folder allows
43+
for components to be reused across multiple pages, which helps keep the site consistent and easier to maintain.
4244

43-
```assets``` This folder contains static files like images, CSS (styles), and JavaScript (scripts) used to style and add functionality to the website.
44-
These files are served to users when they visit the site, making it look nice and interactive. Storing all the designs and functionality-related files in one place,
45-
keeps the repository organized.
45+
```assets``` This folder contains static files like images, CSS (styles), and JavaScript (scripts) used to style and add functionality to the website.
46+
These files are served to users when they visit the site, making it look nice and interactive. Storing all the design and functionality-related files in one place
47+
keeps the repository organized.
4648

47-
```docs``` This folder holds documentation files related to the project. It provides extra information for developers or contributors,
48-
like how to set up or use the project. This extra information gives developers the opportunity to contribute to this repository beyond just the README file.
49+
```docs``` This folder holds documentation files related to the project. It provides extra information for developers or contributors,
50+
such as how to set up or use the project. This extra information gives developers the opportunity to contribute to this repository beyond just the README file.
4951

5052
```node_modules``` This folder contains all the dependencies (external libraries and tools) managed by Node.js, which are needed to build or run the project.
51-
It provides the code libraries the project relies on, such as tools for building the website and running workflows.
52-
53+
It provides the code libraries the project relies on, such as tools for building the website and running workflows. It ensures the project works as expected without
54+
requiring developers to manually install every dependency.
5355

56+
```script``` This folder stores automation scripts used for specific tasks, like testing, building, or deploying the project. It runs the commands or tools
57+
to streamline workflows, such as running tests or ignoring specific URLs during builds. This folder automates repetitive tasks, saving time
58+
and reducing human error.
5459

60+
```test``` This folder contains test files and configurations to ensure the project works as expected. It runs checks (tests) on the code, workflows, or site functionality
61+
to catch bugs or issues before changes are merged. The files in this folder maintain the quality of the project by verifying everything works correctly, which is especially important
62+
for collaborative projects.
5563

5664
## Acknowledgments
5765

0 commit comments

Comments
 (0)