-
Notifications
You must be signed in to change notification settings - Fork 3
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
Remove layers of history from documentation? #11
Comments
It would be very good to update the Description -part of the Commentary to remove the version layers. Regarding the Changes -part:
Regarding the generating the README.md:
|
I did some clarifying of the Commentary section in commit d22947c. Hopefully it is a bit less convoluted. |
That's better; thanks! |
I think this issue can be closed? |
Yeah, let's close this. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Independent of the per-version defaults configuration, I think it's confusing to have historically-layered documentation; that is what release notes are for. I guess I'd move the current change history from the sources to a separate
ChangeLog
or similar). I'd be happy to make a patch to remove references to different versions from the main documentation if you agree (except where they refer to the version-based configuration options).[Comment updated to reflect my realising that
README.md
is a generated file!]The text was updated successfully, but these errors were encountered: