isocpp / isocpp/CppCoreGuidelines
Add an index page?
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 45.3k
- Forks
- 5.6k
- PR merge metrics
- No merged PRs in 30d
Description
It would be nice to have a global index page. The guidelines are pretty difficult to search at the moment. I tried and failed to look up iterator best practices. There is a lot of iterator example code in the guidelines that have little or nothing to do with iterators, making them difficult to search.
In terms of implementing this, I noticed you're embedding some semantic info in A tags in # headers. You could add an attribute to it for tags, e.g.:
## <a name="SS-fct-def" tags="function,lambda,return type,template">F.def: Function definitions
You could then write a remark plugin to generate the actual index.
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 by reviewing the guideline headers and their existing anchor markup, especially the iterator-related sections mentioned in the issue, then inspect how the guidelines are generated to determine where a remark plugin could fit. Done means a global index exists and makes relevant guideline topics, including iterator best practices, easy to find.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100