Open jkowalleck opened 10 hours ago
this is an RFC; feel free to comment. i might modify the initial request to reflect the latest consensus. :D
Lets discuss requirements.
I do not want to discuss actual solutions right now.
(yet, we could publish to github pages, or readthedocs.io, or something else...)
(yes, we could generate via pandoc
, or phinx
, or rst2html
, or something else...)
Anyway, if you have a solution that meats all (current) requirements, please let us know: post the URL to the publishing here 👍 and tell where we might find the CI pipelines and configs
github is great for collaborating on the specs, issuing releases, version controlling, and tracking changes. github is not that great for publishing the resulting documents.
i propose to publish the specs in a web-friendly way, so that non-tech people can read and browse the spec without the overhead of github's file browser and rendering/UI burdens.
minimal requirements
master
branch) is published automaticallynon-requirements
out-of-scopes & non-use cases