Skip to content

Commit 2188970

Browse files
committed
update contribution docs
1 parent 51e4364 commit 2188970

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,19 @@ If you have questions or need help, please check out our documentation for a [li
1010

1111
## Improving the docs
1212

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 `sphinx/src/` subdirectory and is formatted using Python’s [reStructuredText system](https://docutils.sourceforge.io/rst.html).
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).
1414

1515
- The docs are built on GitHub Actions and run the `.ci_scripts/update_docs` script.
1616
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.
17+
18+
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.
1819
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+
3. Go into the main folder.
2021
Run the following commands.
2122
* `conda env create -f ./.ci_scripts/environment.yml`
2223
* `conda activate conda-forge-docs`
23-
* `cd sphinx`
24-
* `cd newsfeed && pip install --no-deps .`
25-
* `cd ../src`
26-
* `make html`
24+
* For live builds, `npm install && npm run start`
25+
* For production builds, run `.ci_scripts/update_docs`
2726
4. Make and commit your changes.
2827
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.
2928

docs/user/contributing.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,13 @@ If you are new to the conda-forge community, follow the steps below to make your
5656
4. Run the following commands:
5757
- `conda env create -f ./.ci_scripts/environment.yml`
5858
- `conda activate conda-forge-docs`
59-
- `cd sphinx/src`
60-
5. Make your changes and run the following command to check them:
61-
- `make html`
62-
63-
You can check the changes locally by opening the html files in `_build/html` or running:
64-
- `python -m http.server --directory _build/html`
59+
5. While writing your new documentation, you can use the live preview mode with:
60+
- `npm install` to make sure `node_modules` is up-to-date
61+
- `npm run start` to start the live preview. Every time you save a file, the changes will be reflected instantaneously!
62+
5. Once ready, you can also check how the production build would look like with the command:
63+
- `.ci_scripts/update_docs`
64+
You can check the changes locally by opening the html files in `build/` or running:
65+
- `python -m http.server --directory build/`
6566
6. Add and commit your changes:
6667
- `git add .`
6768
- `git commit -m "your commit message"`

0 commit comments

Comments
 (0)