Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Organized stylebook into guidelines with reference numbers. #36

Open
sliptonic opened this issue Apr 13, 2023 · 2 comments
Open

Organized stylebook into guidelines with reference numbers. #36

sliptonic opened this issue Apr 13, 2023 · 2 comments

Comments

@sliptonic
Copy link
Member

sliptonic commented Apr 13, 2023

Considering this image, there are several tools enabled that shouldn't be, but for different reasons.

It would be nice to create issues in the tracker and reference these problems while being able to say what's wrong without reinventing the wheel every time. For example, the issue creator should be able to say;
"The Draft 'manage layers' button is enabled when it shouldn't be per guideline XXX.YYY.Z"
or
"The link tool group is improperly enabled per guideline XXX.YYY.X"

2023-04-13_13-50

Whichever number scheme is used should allow the handbook to be reorganized in the future. large pages may be split into smaller ones.

@chennes
Copy link
Member

chennes commented Apr 13, 2023

Maybe for citations you say both the section number and its title? So if they are renumbered in the future they could potentially get matched back up.

@chennes
Copy link
Member

chennes commented Oct 15, 2023

Here's an example of how the C++ Core Guidelines does it:
https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#es23-prefer-the--initializer-syntax

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants