Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

As a external user of Vuu (OSS library consumer) I would like clearer and better stuctured documentation #1263

Open
chrisjstevo opened this issue Mar 12, 2024 · 2 comments
Assignees

Comments

@chrisjstevo
Copy link
Contributor

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

@chrisjstevo chrisjstevo self-assigned this Mar 12, 2024
@rumakt
Copy link
Contributor

rumakt commented Mar 12, 2024

I like the idea, it nicely introduces structure to the documentation and further guidance on where to put a new doc.

@chuchee
Copy link
Contributor

chuchee commented Mar 13, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants