Closed gr2m closed 7 years ago
thanks for taking the initiative @austinjreilly.
If I understood correctly, the API section of the hoodie-account-client README is up to date, but the documentation site is not.
Yes, that’s correct.
Make a list of all pages and/or sections that need to be updated
Good first step. :+1:
Make a banner or indicator of some kind to make it clear that the content on that page references the old version of Hoodie.
I’d suggest we need two things
Update the documentation to reflect the changes in Hoodie Camp.
It’d start by creating a new branch camp
where we invite everyone to work together on this.
Remove banner/indicator that page references old documentation
As mentioned above, I would not entirely remove the old version, there will be people still using it for some time.
it doesn't look like the #docs channel in Slack is very active
Let’s reactivate it.
did you setup the documentation page locally yet? I’ve just updated https://github.com/hoodiehq/documentation#running-the-doc-site-locally – let me know if that works for you
I actually did have the documentation page running locally last night, but I pulled this morning and got it working again.
I'll get started on these tasks tonight.
Is everything that needs to be updated on the api/client/hoodie.account.html page?
I began comparing the headings of the README with the contents of that page, and it looks like there isn't a lot of overlap at all. That, combined with your comment that some people will continue using the old API makes me think that there should be some kind of pre-Camp subdirectory on the docs site where the old documentation is kept.
Hey @austinjreilly are you still interested in helping? We could really use a hand and someone who can take more ownership to finish the docs. The basic setup is done, and when you go to http://docs.hood.ie/ you see the link to the "Camp Release" in the header. The source files are all here: https://github.com/hoodiehq/documentation/tree/gh-pages/camp
It’s one of our major concerns right now to finish the documentation and the tutorials, so that we can deprecate the old docs, the current state is very confusing to people and creates a lot of extra support efforts on the team’s shoulders as we have to support both versions right now
Please let me know if you’re still interested, I’m happy to walk you through
Hey all, I would like to move our docs to readthedocs.org. Please see my issue on https://github.com/hoodiehq/discussion/issues/109 and let me know what you think
that’s done 👍
If I understood correctly, the API section of the hoodie-account-client README is up to date, but the documentation site is not.
The documentation on the site needs to be updated to match the README.
As we talked about last week, I think there are few first steps to get started:
Does that make sense?
Also, it doesn't look like the #docs channel in Slack is very active. Is most of that conversation happening in the #general channel, if it's happening at all?