Closed kuizeo closed 11 months ago
Note for those unfamiliar with the syntax: when exported (e.x. as HTML or a PDF), this will not appear. On GitHub, it appears as a table at the beginning of the file.
I like it! This is a great time to make the change too.
My primary concern is that there'd no longer be an easy way to tell if a standard is finalized without going into it. I suppose the README.md could be manually updated with a table/list. On the other hand, this would definitely streamline the process.
Anyone else have thoughts on this?
In the PR I'm working on, the README has a list of these. I suppose the list could be generated as follows:
Surround the list with comments:
Lorem ipsum...
<!--LIST:START--!>
Early Drafts:
* PSC 001: ...
<!--LIST:END--!>
/<!--LIST:START--!>.+<!--LIST:END--!>/s
with an autogenerated list.The aforementioned script could be ran using GitHub actions.
Also, status
should instead show a more specific status, e.x. "Early Draft" or "Working Draft".
Presently, drafts have a special header and are put in the
drafts/
folder, while final documents have a normal header and are put in thefinal/
header. Instead of keeping two copies of each document, I propose we simply use YAML metadata at the beginning of the file to keep track of the (a) identifier of the document, (b) the title of the document, (c) the status of the document (final or draft), and (d) the version of the document (array of three integers: major, minor, patch). We may then leave the header as it would appear in the final version even in drafts.For instance: