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

For the 0.17.0 changelog - add a "what's new in 0.17.0" page to the main ReST docs #812

Closed
Dunbaratu opened this issue Apr 14, 2015 · 1 comment
Labels
duplicate Will close because another PR or issue is the same. (please link to it when using this label)

Comments

@Dunbaratu
Copy link
Member

To keep the changelog from being too verbose, have it just link to more long descriptions over in the main ReST docs. - I think we should have a single page for just "what's new" for the existing users to pore over so they don't have to read the entire document tree again.

The page would occupy the halfway point between the terseness of the changelog (which would JUST mention things like "user functions" as a one-liner, and link to this page), and the verbosity of the full rest of the documentation.

The intended audience would be people who already know kOS and just need to find out what changed, and be given a bunch of links into the places in the main docs where the changes are fully described.

@Dunbaratu Dunbaratu added the documentation Change the Sphinx user documents. label Apr 14, 2015
@Dunbaratu Dunbaratu added this to the v0.17.0 Punchlist milestone Apr 14, 2015
@Dunbaratu Dunbaratu changed the title For the 0.17.0 changelog - add a "what For the 0.17.0 changelog - add a "what's new in 0.17.0" page to the main ReST docs Apr 14, 2015
@Dunbaratu Dunbaratu added duplicate Will close because another PR or issue is the same. (please link to it when using this label) and removed documentation Change the Sphinx user documents. labels Apr 14, 2015
@Dunbaratu
Copy link
Member Author

Moved this to just a comment under issue #716 , to reduce the amount of extra issue numbers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate Will close because another PR or issue is the same. (please link to it when using this label)
Projects
None yet
Development

No branches or pull requests

1 participant