satisfactorymodding / satisfactorymodding/Documentation
Require sub-mod docs to run their own link checkers and/or report link checker errors to them
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 28
- Forks
- 96
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/satisfactorymodding/Documentation/pull/314 kicked the can on this issue but we should implement a real fix
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Read the linked pull request #314 first to understand what was deferred and how sub-mod documentation is currently checked. Identify the existing link-checking entry points and determine whether each sub-mod should run its own checker or receive reported errors; done means the agreed behavior is implemented and verified for sub-mod documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100