openframeworks / openframeworks/openFrameworks
Link to "examples" page doesn't show examples, and isntead tells you to go to another page, without linking anything.
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 10.4k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 9
Description
The problem here under Usage (1):
https://github.com/openframeworks/openFrameworks/blob/master/docs/table_of_contents.md
Which refers to here (2):
https://github.com/openframeworks/openFrameworks/blob/master/docs/apps.md
Which refers to here (3):
https://github.com/openframeworks/openFrameworks/tree/master/examples
(1) needs to forward straight to (3)
Contributor guide
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 with the Usage link in docs/table_of_contents.md and follow its reference to docs/apps.md. Update the Usage entry so it links directly to the examples directory, then verify the rendered documentation no longer routes readers through the intermediate page.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100