gr2m
commented
7 years ago Thanks for taking the initiative! It would really help a lot to put the new documentation on the docs.hood.ie page and move the old one to something like /legacy or get rid of it altogether
Here are a few things I found, I suggest we create follow up issues for them:
- [x] Fix formatting for the "Private User Store" section: http://docs.hood.ie/camp/hoodieverse/glossary.html
- [x] Tutorial Part 2 is missing: http://docs.hood.ie/camp/tutorials/
- [x] I would suggest we can get rid of the map app / chat app / time tracker app for now and create issues for them to add them later, because the new Hoodie does not yet have all the required functionality
- [x] remove the links to Map App / Chat App
- [x] The Hoodie API: http://docs.hood.ie/camp/techdocs/api/client/hoodie.html
- [x] The account API: http://docs.hood.ie/camp/techdocs/api/client/hoodie.account.html
- [x] The store API: http://docs.hood.ie/camp/techdocs/api/client/hoodie.store.html
- [x] The connectionStatus API: http://docs.hood.ie/camp/techdocs/api/client/hoodie.connection-status.html
- [x] The log API: http://docs.hood.ie/camp/techdocs/api/client/hoodie.log.html
- [ ] Plugins can remain empty, it’s okay, we are still working on it, it’s not a blocker to launch the new documentation: http://docs.hood.ie/camp/plugins/
- [x] Deployment: http://docs.hood.ie/camp/deployment/ we should add documentation to deploy to Linux, using Docker and to now / heroku
- [ ] We can get rid of the community documentation section because we should move it to hoodie.camp. But we could still reference it or discuss what we can tell people to go from there
pmbanugo
Hi.
I noticed that the tutorial/doc misleads people to the old doc, which I think has much difference than the current hoodie. I spent time reading through the old sample/doc and I noticed someone else too did. For the new doc, most parts are incomplete.
I've looked at the open issues, seems they're all from a long time ago. Seems no motion has been made towards the doc for a long time. I'd like things to get started again, so that the doc looks as awesome as the software :)
I think if we can make notes here, to point the direction we want to take towards documentation, what needs to be updated, what needs to be added, pages/sections/documentations that needs to be made for the latest version of hoodie listed out, we can further create issues to mark specific ones and track the progress or have it listed so that new people willing to contribute will it easy and clear as to what needs to be worked on.
I think Machiko Yasuda noted some things she thinks needs to be updated or added, so I think we should start from there or anyone can also throw in their suggestions.