Skip to content

Commit 7573eb0

Browse files
authored
Merge pull request #1385 from prachi237/master
Update README.md (issue #1305 )
2 parents 19b11ab + 09cbfd8 commit 7573eb0

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,25 @@ 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
12-
13-
The docs are built on GitHub Actions and run the `.ci_scripts/update_docs` script.
14-
To build the docs locally, you should do the following:
15-
1. Clone the repository into your local machine.
16-
2. Go into the main folder. </br>
17-
Run the following commands.
18-
3. `conda env create -f ./.ci_scripts/environment.yml`
19-
4. `conda activate conda-forge-docs`
20-
5. `cd newsfeed && pip install --no-deps .`
21-
6. `cd ../src`
22-
7. `make html`
23-
2411
## Improving the docs
2512

26-
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`.
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 in the src/ subdirectory and is formatted using Python’s [reStructuredText system](https://docutils.sourceforge.io/rst.html).
14+
15+
- The docs are built on GitHub Actions and run the `.ci_scripts/update_docs` script.
16+
We are glad to know that you would like to contribute. To build the docs locally, follow the steps mentioned below:
17+
1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the [conda-forge.github.io](https://github.com/conda-forge/conda-forge.github.io) repository to your own GitHub user account.
18+
2. [Clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) this fork onto your computer.
19+
3. Go into the main folder. </br>
20+
Run the following commands.
21+
* `conda env create -f ./.ci_scripts/environment.yml`
22+
* `conda activate conda-forge-docs`
23+
* `cd newsfeed && pip install --no-deps .`
24+
* `cd ../src`
25+
* `make html`
26+
4. Make and commit your changes.
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.
28+
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 "**
2730

2831
## conda-forge dev meetings
2932

0 commit comments

Comments
 (0)