search

ethereum-oasis-op / baseline-standard

Repository for the Baseline standards team and specification work
Creative Commons Zero v1.0 Universal
18 stars 33 forks source link

Overview repeats the ToC twice #92

Closed chaals closed 3 years ago

chaals commented 3 years ago

The overview section is one part overview f the document, but that is really just a restatement of the table of contents, adding to the redundancy by listing most of the section contents in the first line about the section and then again in a list.

Removing this whole list would trim the document down for easier reading with no appreciable loss of information or legibility.

Therecanbeonlyone1969 commented 3 years ago

Not uncommon practice in standards to have a ToC and repeat the main sections and some or all subsections with some clarification what they represent, which the expansion of the ToC in the overview does. cc @chaals

Therecanbeonlyone1969 commented 3 years ago

@chaals ... per WG meeting 11/18/2021, repetition is warranted. Closing issue.