We heard you, the documentation needed some improvement, while keeping the open and collaborative model of the current GitHub repository.
We opted for GitBook. Here are the main reasons:
- Much better usability
- It’s based on the existing GitHub repo (when you change the repo, it updates)
- Anyone can edit the current page in GitHub, the link is always present.
- Supports versioned documentation (using git repo branches)
- Offers a global search box
- A table of contents is automatically generated and always visible
- The pages can be organised in topics and subtopics
- As staff, we get an amazing editor in the backend that saves the work directly on GitHub.
- GitBook is proprietary code, but the bidirectional integration with GitHub does not lock us in.
Going forward, we are going to work on giving more structure to the existing documentation, and will add more examples.
Thanks to all the ReadonlyREST users