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

Docs: What's new in Alda X.X.X? #12

Open
daveyarwood opened this issue Feb 1, 2017 · 0 comments
Open

Docs: What's new in Alda X.X.X? #12

daveyarwood opened this issue Feb 1, 2017 · 0 comments

Comments

@daveyarwood
Copy link
Member

Part of #8.

This should be done by modifying the docs folder in alda-lang/alda. The docs are kept in sync with releases and used to generate http://alda.readthedocs.io, which will be CNAMEd to docs.alda.io.

The way readthedocs.io is set up, documentation versions are automatically mapped to branches of the repo. The latest version in each series of Alda releases (e.g. 1.0.X, 1.1.X, 1.2.X...) will have its own version of the documentation, corresponding to the docs folder in that branch of the alda-lang/alda repo.

I like the way the Python documentation site handles this:

https://docs.python.org/3 (landing page)
https://docs.python.org/3/whatsnew/3.6.html (summary of changes since the last minor version, 3.5)
https://docs.python.org/3.6/whatsnew/changelog.html (detailed changelog for this series of releases)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Alda
  
Up for Grabs
Development

No branches or pull requests

1 participant