levibostian / Wendy-Android

Build offline first Android mobile apps. Remove loading screens, perform tasks instantly.
https://levibostian.github.io/Wendy-Android/wendy/
MIT License
64 stars 16 forks source link

Create user centered documentation website #51

Open levibostian opened 5 years ago

levibostian commented 5 years ago

At this time, the README for the project does what it needs to do. It covers everything you need to know to install and use Wendy in your own app. However, as Wendy adds more functionality to itself (such as testing utilities), and it becomes more stable and ready for more of the public to use, a dedicated documentation website is a huge step forward for the library.

Documentation beyond a README. A full documentation website including:

Requirements:

levibostian commented 5 years ago

At this time, I am thinking about using VuePress as the project to generate the docs.

Pros:

Cons: