Closed
Description
Most of the development and index pages of the current docs would work better as a dedicated static site, where changes can be made without having to copy them to each release branch, etc.
This will also be a good excuse to rearrange a little bit.
Specifically, move these to the new site:
- Everything in
index.rst
which is not the Documentation section -- so the intro/about, installation, development, and getting help sections - The Installation and Development pages themselves
- Installation is slightly more tied to the code itself than the rest, so it's a maybe -- e.g. we occasionally get patches that add to the install docs (such as the PyPM chunk).
- Split out the Releases & Support of older releases sections from Development into their own page -- that info is both user and dev related.
- Probably split existing intro material into front-page and "about the project" content...
- ...so we can add more to the front-page, such as:
- Latest stable versions & link to their changelogs
- Up-front-and-personal links to various things ("Need help? ", "Want to download? ", "Want to contribute? " etc)
This would then leave the in-code docs covering:
- Some sort of basic intro, probably pointing to the main site
- The notes about the docs themselves
- Tutorial
- Usage docs
- FAQ
- API docs
- Changelog
Finally, add this entirely new content to the new site:
- Blog for announcements/releases - and then ML posts become links here
- Roadmap page that gets updated periodically with what's ahead