KhronosGroup / KhronosGroup/Vulkan-Hpp
Create an intermediate README in docs/
- Dominant language
- C++
- Stars
- 3.8k
- Forks
- 374
- Avg merge
- 23h 4m
- Merged PRs (30d)
- 32
Description
With the README overhaul in #2358, the documentation is split up into multiple files in `docs/`.
Some repos place a `README.md` into this intermediate folder, showing a detailed description of what each documentation file contains, which is rendered nicely in the GitHub view.
After the PR in question is merged, we could think about adding one ourselves.
Contributor guide
Research direction
Review the README overhaul in #2358 and the documentation files currently in docs/ after that work is merged. Add a README.md in docs/ that gives a detailed description of what each documentation file contains and renders clearly in GitHub; completion means the intermediate folder has that overview.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100