- Notifications
You must be signed in to change notification settings - Fork283
Table of Contents vs Summary section#218
-
@bbatsov asked in#216 whether the TOC satisfied my request for a distinct "bullet point" summary of the guidelines. The TOC items indicate whattype of guidelines there are but not theactual guidelines themselves. For example "Link Breaks in ns" just tells you that the guideline isabout newlines in I agree that duplicating content introduces a maintenance overhead but there is currently no way to quickly read over just the guidelines themselves -- you have to wade through the whole document, picking them out of the rationale and examples. I think having an easy-to-read summary at the start of the document is worth that extra maintenance. |
BetaWas this translation helpful?Give feedback.
All reactions
👍 1
Replies: 1 comment
-
I should clarify that the titles are pretty bad currently, as post of them were auto-generated from the anchors that guidelines used to have before the conversion to the current format. Here's the commit for reference798001a It'd be nice if we improved the titles to be both more descriptive and more consistent. I guess we'll have to do this at some point.
Fair enough. There might be some way to generate a TOC for each section to avoid having to do this manually. |
BetaWas this translation helpful?Give feedback.