search

isocpp / CppCoreGuidelines

The C++ Core Guidelines are a set of tried-and-true guidelines, rules, and best practices about coding in C++
http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines
Other
42.59k stars 5.43k forks source link

Add an index page? #1842

Open joeedh opened 2 years ago

joeedh commented 2 years ago

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.

joeedh commented 2 years ago

I've submitted a pull request with a basic index page remark plugin.