vuu
vuu copied to clipboard
As a external user of Vuu (OSS library consumer) I would like clearer and better stuctured documentation
Feature Request
The current structure of the Vuu documentation reflects what Chris though was important while we were open sourcing Vuu. Now with the experience of people using the project It would like to propose a refactor of the documentation.
Suggest structure is something like this:
+ Using Vuu
+ Getting Started
+ Core Concepts
+ Adding Data
+ Editing Data
+ Adding Behaviour
+ Adding UI Components
+ AuthN and AuthS
+ Features
+ Examples
+ Plugins
+ Coding Vuu
+ Threading Models
+ Filter and Sorts
+ Server to UI Data Api
+ JSON Encoding
+ Wire Protocol
+ Contributing to Vuu
+ The Team
+ Contact
I like the idea, it nicely introduces structure to the documentation and further guidance on where to put a new doc.
I like this structure. It is clearer and makes it easier to find a doc. One thing I wanted to add is that it may be helpful to keep Core Concepts at the top level:
+ Introduction
+ Core Concepts
+ Using Vuu
+ Getting Started
+ Adding Data
+ Editing Data
+ Adding Behaviour
+ Adding UI Components
+ AuthN and AuthS
+ Features
+ Examples
+ Plugins
+ Coding Vuu
+ Threading Models
+ Filter and Sorts
+ Server to UI Data Api
+ JSON Encoding
+ Wire Protocol
+ Contributing to Vuu
+ The Team
+ Contact