Broken link in "Templates generator" docs page
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Open docs/source/utilities/yaml_generator.rst and inspect the outdated GitHub link on the referenced line. Locate the current yaml_templates_generator.py path in httomo-backends, update the link, then rebuild or preview the documentation and verify that it no longer returns a 404.
Written by the indexing model from the issue text.
Description
The following github link in yaml_generator.rst is outdated and returns a 404 when visiting it in the deployed docs: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/docs/source/utilities/yaml_generator.rst?plain=1#L5
The link was valid when the yaml_templates_generator.py script was in httomo, but that script has since been moved to httomo-backends.
- Dominant language
- Python
- Stars
- 0
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DiamondLightSource/httomo-backends
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
documentation
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
documentation question
Difficulty 5/5 Over a week Newbie friendliness 25/100
DiamondLightSource/httomo-backends#10 · 2 comments ·
-
documentation question
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
All issues in DiamondLightSource/httomo-backends
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
BasedHardware/omi#20271 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
openai/openai-cookbook#3153 ·
Maintainers usually reply within 1 day
-
cvss-severity:high devguard l3montree-cybersecurity/devguard/devguard pkg:golang/github.com/l3montree-dev/devguard risk:low state:open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
l3montree-dev/devguard#3146 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
bug confirmed issue
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
open-webui/open-webui#31849 · 2 comments ·
Maintainers usually reply within 1 day