Skip to content

Commit ca10a6b

Browse files
authored
Update README.md
1 parent df804a4 commit ca10a6b

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,18 @@ If you have questions or need help, please check out our documentation for a [li
1111
## Building the docs
1212

1313
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>
14+
We are glad to know that you would like to contribute. To build the docs locally, follow the steps mentioned below:
15+
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.
16+
2. [Clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) this fork onto your computer.
17+
3. Go into the main folder. </br>
1718
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`
19+
* `conda env create -f ./.ci_scripts/environment.yml`
20+
* `conda activate conda-forge-docs`
21+
* `cd newsfeed && pip install --no-deps .`
22+
* `cd ../src`
23+
* `make html`
24+
4. Make and commit your changes.
25+
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.
2326

2427
## Improving the docs
2528

0 commit comments

Comments
 (0)