Skip to content

Commit a0233ac

Browse files
committed
Update contributing docs
1 parent c0d0807 commit a0233ac

File tree

3 files changed

+3
-2
lines changed

3 files changed

+3
-2
lines changed

docs/for_contributors/docs_contribution_quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Acquire **Docs** Contribution Quickstart
1+
# Contribute to docs
22

33
1. Make sure you have a fresh environment with the latest mkdocs and mkdocs-material installed. You can install them with `pip install -r requirements.txt` from the root of the repository.
44
2. Your pages should be written as markdown files, using the basic markdown syntax or following the [mkdocs](https://www.mkdocs.org/user-guide/writing-your-docs/) or [material for mkdocs](https://squidfunk.github.io/mkdocs-material/reference/formatting/) syntax.

docs/for_contributors/update_version.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How to update the documentation version
1+
# Update docs version
22

33
After every new release of Acquire Python, the documentation version needs
44
to be manually updated. This can be done by issuing the following command on the

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ nav:
7171
# - acquire-imaging/tutorials/zarr/compressed.md
7272
- For contributors:
7373
- for_contributors/index.md
74+
- for_contributors/codebase.md
7475
- for_contributors/docs_contribution_quickstart.md
7576
- for_contributors/update_version.md
7677

0 commit comments

Comments
 (0)