artefactual / artefactual/atom-docs
Update AtoM docs to use `|version|` in url links
Open
Beginner friendly
- Dominant language
- Python
- Stars
- 21
- Forks
- 31
- PR merge metrics
- No merged PRs in 30d
Description
In [this PR](https://github.com/artefactual/atom-docs/pull/247), we added [sphinx_version_ref](https://pypi.org/project/sphinx-version-ref/) to manage version number in url links.
Docs should be updated to use `|version|` in links where applicable.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reading PR 247 to understand how sphinx_version_ref handles versioned URL links, then search the documentation for links where the version placeholder applies. Done means all applicable links use |version| and the documentation still builds successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100