search

ARM-software / ebbr

Embedded Base Boot Requirements Specification
Creative Commons Attribution Share Alike 4.0 International
112 stars 36 forks source link

Request-for-comments about adding version annotations #118

Open vstehle opened 6 months ago

vstehle commented 6 months ago

In chapter 1 we say that:

new requirements will be clearly documented as being over and above what was required by a previous release.

We have started to do so in the index history table, but we could also add more explicit annotations nearer to the concerned chapters using specific annotations as shown here.

This is a request-for-comments, to fuel discussions, and is not to be merged.

Please give your feedback in this pull request.

vstehle commented 6 months ago

Rebased.

xypron commented 1 month ago

Having the version information at the end of each chapter requires a lot of scrolling. Please, place the information above the referenced element.

versionadded makes some sense. But versionchanged does not tell what the change was. Could be a typo fix or a big change.

The HTML output uses CSS class "versionmodified". You can use it CSS to have the versionadded information in smaller type and in a different color. See https://docs.readthedocs.io/en/stable/guides/adding-custom-css.html. For PDF output see https://www.sphinx-doc.org/en/master/latex.html.