Update documentation authored by drebs's avatar drebs
......@@ -8,12 +8,39 @@ Current pieces of documentation for soledad are:
* https://leap.se/en/docs/design/soledad (a lot of discussion, some reference, a bit of how-to).
* https://soledad.readthedocs.io/en/latest/ (a lot of reference, some discussion, a bit of how-to).
# Proposed structure / wishlist
Tutorials (learning oriented):
# What is missing in current documentation
How-to guides (goal oriented):
* where to get source code
* how to install (pip, debian)
*
Discussions (understanding oriented):
# Proposed structure / wishlist
Reference (information oriented):
* Tutorials (learning oriented)
* How-to guides (goal oriented)
* Discussions (understanding oriented)
* Reference (information oriented)
# Current structure
* Soledad Client
* Soledad Server
* General information
* Server database organization
* Server Configuration File
* Authentication
* Authorization header
* Services API tokens file
* Implementation
* Reference
* Environment Variables
* Document attachments
* Soledad “Incoming Box” Specification
* Development
* Contributing
* Backwards-compatibility and deprecation policy
* Tests
* Benchmarks
* Changelog
* Migrations
* Soledad Server 0.8 to 0.9 - Couch Database schema migration needed
\ No newline at end of file