The Vision

We'd like to make Subxt an approachable and obviously well maintained, documented and supported tool to encourage developers to use it. Great docs are key to that. Some examples of such docs that I think we could draw inspiration from:

• https://use.ink/
• https://hyper.rs/
• https://serde.rs/

The Plan

• Assess whether we would benefit from a separate "Book" or whether we should focus more on docs.rs documentation.
• If we want a book:
  • Find a tool/approach that works. I'd like any code examples in our docs to be automatically checked by rust. being able to host the docs in the same repo would make it easy for us to develop/test/have them with every release and branch. Let's see what the easiest/best choice of tool is for create such docs is.
  • Plan out the docs structure. I think it should be very example focused. it should complement and not replace the API docs, so higher level examples and descriptions of the problems and approaches taken.
  • Talk to the docs people about this; they might be able to help in all areas of this!