search

AMWA-TV / is-template

Template repo for NMOS specifications
https://specs.amwa.tv/is-template
Apache License 2.0
0 stars 4 forks source link

Make list of docs from README #25

Closed peterbrightwell closed 3 years ago

peterbrightwell commented 3 years ago

Default for new repos should be to use docs/README.md to specify the doc list order and levels, rather than use document numbering.

garethsb commented 3 years ago

Would it be worth making clear in the comment that bullets have to be - and any other constraints on link line syntax? Is it clear that all documents have to be listed here, i.e. not OK to have some that are just linked from other docs? Are all links relative to docs/? Would it be alright if people organised files in sub-directories?