chantra
commented
8 months ago Another benefit is that you will not need to deal with PRs like #29, #31 , #35 . The live document will be updated automatically, when a new tag is created, a new version will be generated with the right -{version}. More details in https://github.com/martinthomson/i-d-template/blob/main/doc/FEATURES.md
https://github.com/martinthomson/i-d-template allows to easily create gh-pages of the documents, making them available in both .txt and .html format and viewable as HTML via github pages. For example: https://martinthomson.github.io/i-d-template/sample.html
This makes reading the document easier, but the repo also comes with a bunch of tooling/linting enforcement that will help keeping the document syntax valid. It will also make the workflow with IETF datatracker smoother.
I am not sure how this repo was created, but it would be nice to be able to generate the GH pages for it.
I gave a try on my repo and generated the GH pages. index deleg draft
using this branch: https://github.com/chantra/fl1ger-deleg/commits/fix_md_formats/
There is 2 commits there. 1) https://github.com/chantra/fl1ger-deleg/commit/b9867484f8ee440747a9dc3cdcb71ebeb59a2d05 is needed to be able to compile the documents properly. 1) https://github.com/chantra/fl1ger-deleg/commit/3a85ae6b5c17d18c25900a7824f8942fe3d4eda5 is quite big and is supposed to set up the repo using martinthomson/i-d-template. The problem is that it would change some existing files like README.md, CONTRIBUTING.md so we cannot just merge this in. I believe this is an artifact that only happen on setup though, so it should be trivial to manually revert the couple of change we do not want.