Documentation reorganisation

esl / MongoosePush

MongoosePush is a simple Elixir RESTful service allowing to send push notification via FCM and/or APNS.

Apache License 2.0

108 stars 24 forks source link

Documentation reorganisation #183

Closed zofpolkowska closed 4 years ago

zofpolkowska commented 4 years ago

Here is the new (wip) documentation.

DONE:

Created a list of guides from the contents of the huuuuge README.md.
Organized modules into groups.
Added versions dropdown list.
Added gh_pages_docs mix task.

TODO:

[ ] Include the documentation generate/update process in CCI (separate PR).

zofpolkowska commented 4 years ago

README.md and introduction.md are pretty much identical, is it possible to have just one of them instead of two files?

Also, the contents of this intro are pretty much pieces of other sections. Maybe we could spice it up with more "marketable" content there, together with links to the main documentation. @goddammit any advise?

Yes, the thing is that the introduction/readme was too short otherwise.

zofpolkowska commented 4 years ago

@NelsonVides @kmakiela @goddammit @leszke any suggestions regarding what should be on the "landing" page in the docs + GH readme ?