school-brainhack / school-brainhack/school-brainhack.github.io
Check all the links works
Open
Nobody has claimed this yet.
brainhackschool-2023
good first issue
maintainence
- Dominant language
- Jupyter Notebook
- Stars
- 42
- Forks
- 185
- PR merge metrics
- No merged PRs in 30d
Description
We need to build the PRs offline to make sure formatting and relative links works.
I have opened an issue on the technical document, with resources:
https://github.com/school-brainhack/school-brainhack.readthedocs.org/issues/4
cc @clarkenj
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
Start by reviewing the technical document and the linked issue for the stated resources, then inspect how pull requests are currently built offline. Done means the relevant formatting and relative-link checks work for offline PR builds and all links are verified.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100