isocpp / isocpp/CppCoreGuidelines

Finding a guideline by a word in its title

Open
#1,719 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
45.3k
Forks
5.6k
PR merge metrics
No merged PRs in 30d

Description

Here's an issue I encountered recently:

I and a colleague of mine were enabling clang-tidy for our code base using modernize-use-override as the check to verify that it works.

While committing the emerging code changes, we wanted to mention and link to the according core guideline. So I went to the web page, searched for override and found 60 matches, which was too much. I wanted to search in guideline titles, but couldn't, as they are inline with text and aren't extracted to a table of contents (TOC).

Scrolling the document using mouse wheel was too slow, dragging the slider too fast. In the end, we found the guideline but this was a frustrating experience, and it's not a great advertisement for the guidelines.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file, test, or entry point is identified in the issue. Start by locating how guideline titles are represented in the web document and how its table of contents is generated; then assess a title-focused navigation or search approach. Done means users can find a guideline by a word in its title without scrolling through unrelated body matches.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.