Until 1.0.0, Amethyst will is virtually guaranteed to go under a lot of change. That means the mdBook content will be frequently out of date. Until we hit 1.0, I think it would be more reasonable to assemble the mdBook to reflect that. I’d like to make two proposals to that effect:
- Rewrite the mdBook to be
- a minimal setup guide
- a conceptual introduction that gives people what they need to figure the rest out
- an aid in tracking the transitions between versions, as to enable early users to keep up
- Keep a template evolving, using shorthand, to make it so writing the 1.0 mdBook is simply replacing key words and phrases with flushed out text and examples.
With a more minimal book for giving a solid foundation and a template to streamline the 0.X to 1.0 transition, this allows us to write less to support our users. We have to keep track of large portions of the engine and how best to use it, writing less means our catch-up work takes less time to commit.