Skip to content

Commit 3fa751e

Browse files
authored
Update README.md
1 parent 570e031 commit 3fa751e

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ This repository
88

99
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).
1010

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).
1214

1315
The docs are built on GitHub Actions and run the `.ci_scripts/update_docs` script.
1416
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
2426
4. Make and commit your changes.
2527
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.
2628

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 "**
3230

3331
## conda-forge dev meetings
3432

0 commit comments

Comments
 (0)