Skip to content

Commit 932a952

Browse files
committed
Add links and reviewers' suggestions
1 parent fbc5113 commit 932a952

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# napari docs
22

3-
This repository contains the sources for the napari documentation. This includes tutorials, how-tos and the autogenerated API documentation extracted from the source code docstrings.
3+
This repository contains the sources for the napari documentation. This includes tutorials, how-tos and other narrative documentation. The autogenerated API documentation is extracted from the source code docstrings, which live on https://github.com/napari/napari
44

55
## mission, values, and roadmap
66

docs/developers/documentation/index.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ you will require:
2222
- A [GitHub](https://github.com) account.
2323

2424
You should first [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
25-
and clone the `napari/docs` repo to your machine, and navigate to the resulting
26-
folder:
25+
and clone the [napari/docs](https://github.com/napari/docs) repo to your
26+
machine, and navigate to the resulting folder:
2727

2828
```bash
2929
git clone git@github.com:<your-username>/docs.git napari-docs
@@ -42,8 +42,8 @@ cd napari-docs/
4242
will need to contribute documents containing code or viewer interactions.
4343

4444
- **If you wish to add/amend documentation that does contain code, you will also
45-
require a clean conda environment with a development installation of
46-
napari.**
45+
require a clean conda environment with napari docs dependencies installed, but
46+
with a development installation of napari.**
4747

4848
See the [contributor guide](dev-installation) for details. You should have
4949
[Jupyter notebook](https://jupyter.org/) installed. Familiarity with Jupyter
@@ -208,7 +208,8 @@ locally, or downloading the GitHub Actions built documentation when you submit
208208
your pull request.
209209

210210
To build the documentation locally, run `make docs` from the root of your local
211-
clone of the `napari/docs` repository (assuming you've installed the [docs prerequisites](#prerequisites)).
211+
clone of the `napari/docs` repository (assuming you've installed the
212+
[docs prerequisites](#prerequisites)).
212213

213214
```bash
214215
make docs
@@ -220,14 +221,15 @@ The `make docs` command above assumes your have a local clone of the
220221
the `napari/docs` clone.
221222
```
222223

223-
The rendered HTML will be placed in `docs/_build`. Find `index.html` in this folder and drag it
224-
into a browser to preview the website with your new document.
224+
The rendered HTML will be placed in `docs/_build`. Find `index.html` in this
225+
folder and drag it into a browser to preview the website with your new document.
225226

226-
Alternatively, when you submit your pull request, napari continuous integration
227-
includes a GitHub action that builds the documentation and saves the artifact
228-
for you to download. This is another way to check that your built documentation
229-
looks as you expect. To download the built documentation, go to your PR, scroll
230-
down to the continuous integration tests, then:
227+
Alternatively, when you submit your pull request, the napari docs repository
228+
continuous integration includes a GitHub action that builds the documentation
229+
and saves the artifact for you to download. This is another way to check that
230+
your built documentation looks as you expect. To download the built
231+
documentation, go to your PR, scroll down to the continuous integration tests,
232+
then:
231233

232234
1. Click on **Details** next to `Build PR Docs / Build & Upload Artifact (pull_request)`:
233235

0 commit comments

Comments
 (0)