Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Errata section considered kludgy #12

Open
mzabaluev opened this issue Sep 3, 2024 · 3 comments
Open

Errata section considered kludgy #12

mzabaluev opened this issue Sep 3, 2024 · 3 comments

Comments

@mzabaluev
Copy link

This is a collection of documents maintained as a git repository. Errors in the text can be fixed in PRs and attested in revision history. As such, there is no need for a separate Errata section, furthermore, it breaks the natural reading of the specification and can be overlooked.

I suggest replacing this section in the document templates with a "Changes" section listing major revisions and updates.

@apenzk
Copy link
Contributor

apenzk commented Nov 4, 2024

i am in favour and aggree. it is also a duplication of the discussions in the PR that drive the changes.

How about putting the changes section at the bottom of the document and pointing to (closed and successful "update") PRs?. The PR contains a better explanation and more accessible insight into what the changes where. it is a one-liner at the bottom.

@l-monninger
Copy link
Contributor

I would suggest keeping an errata for the reason of important conceptual mistakes that are later fixed--not for small polishes. This is so that, in the long run, other proposers, implementers, etc. can refer to a specific erratum.

@apenzk
Copy link
Contributor

apenzk commented Dec 19, 2024

as agreed per SF the Errata section will be replaced by a Changelog section, to provide an overview of all kind of changes and the relevant PRs. It provides a versioning to the documents.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants