You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,9 @@ This repository
8
8
9
9
If you have questions or need help, please check out our documentation for a [list of ways to interact with us](https://conda-forge.org/docs/user/how_to_get_help.html).
10
10
11
-
## Building the docs
11
+
## Improving the docs
12
+
13
+
You can help to improve the documentation! It is version-controlled in the [conda-forge.github.io repository on GitHub](https://github.com/conda-forge/conda-forge.github.io). The source text is stored there in the src/ subdirectory and is formatted using Python’s [reStructuredText system](https://docutils.sourceforge.io/rst.html).
12
14
13
15
The docs are built on GitHub Actions and run the `.ci_scripts/update_docs` script.
14
16
We are glad to know that you would like to contribute. To build the docs locally, follow the steps mentioned below:
@@ -24,11 +26,7 @@ We are glad to know that you would like to contribute. To build the docs locally
24
26
4. Make and commit your changes.
25
27
5. Submit a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) to the main repository proposing your changes.
26
28
27
-
**Note: "All changes must be made in the `/src` folder and NOT in the `/docs` folder."**
28
-
29
-
## Improving the docs
30
-
31
-
We are constantly improving our documentation and are very grateful for feedback and contributions. If you would like to help, please be aware that the html documentation in the `docs` folder is automatically generated from the source files in the `src` folder. Therefore please always edit the files in `src` and never in `docs`.
29
+
**Note: "All changes must be made in the `/src` folder and NOT in the `/docs` folder. Html files in the ./docs folder are auto generated "**
0 commit comments