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.

Sign up for GitHub

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

Jump to bottom

Update site/docs #247

Closed
3 of 5 tasks
leobauza opened this issue Mar 10, 2017 · 3 comments
Closed
3 of 5 tasks

Update site/docs #247

leobauza opened this issue Mar 10, 2017 · 3 comments
Assignees
@leobauza
Labels
documentation Site

Comments

@leobauza
Copy link
Contributor

leobauza commented Mar 10, 2017 •
edited
Loading

Main things that need to happen:

  • Update the README.md with better instructions to run locally and publish
  • Add a "Contributing" section
  • Add a "Roadmap" section (see What is the roadmap? #258)
  • Add an overview for each subsection (ie. Introduction, Api, Addons, etc)
  • Review all language for clarity and accuracy

@nhunzaker would like to get your thoughts on what I am proposing to add (ie. contributing section, roadmap, overviews).
@leobauza leobauza self-assigned this Mar 10, 2017
leobauza added a commit to leobauza/microcosm that referenced this issue Mar 12, 2017
@leobauza
[vigetlabs#247] Update site README with more detailed instructions
63980ef
leobauza added a commit to leobauza/microcosm that referenced this issue Mar 12, 2017
@leobauza
[vigetlabs#247] Update site README with more detailed instructions
030bd35
leobauza added a commit to leobauza/microcosm that referenced this issue Mar 12, 2017
@leobauza
[vigetlabs#247] Update site README with more detailed instructions
59fc041
leobauza added a commit to leobauza/microcosm that referenced this issue Mar 12, 2017
@leobauza
[vigetlabs#247] Update site README with more detailed instructions
1e18260
leobauza added a commit to leobauza/microcosm that referenced this issue Mar 12, 2017
@leobauza
[vigetlabs#247] Update site README with more detailed instructions
868b789
@leobauza leobauza changed the title Update site/docs [site] Update site/docs Mar 13, 2017
leobauza added a commit to leobauza/microcosm that referenced this issue Mar 13, 2017
@leobauza
[vigetlabs#247] Update site README with more detailed instructions
41c46c8
@leobauza leobauza mentioned this issue Mar 13, 2017
Merged
@leobauza leobauza changed the title [site] Update site/docs Update site/docs Mar 13, 2017
@leobauza leobauza added the Site label Mar 13, 2017
leobauza added a commit that referenced this issue Mar 15, 2017
@leobauza
[#247] Update site README with more detailed instructions
f53795a
leobauza added a commit to leobauza/microcosm that referenced this issue Mar 20, 2017
@leobauza
[vigetlabs#247] add contributing section to the site and .github fold…
a534bf7 
…er with issue/pr templates
leobauza added a commit that referenced this issue Mar 21, 2017
@leobauza
[#247] add contributing section to the site and .github folder with i…
222ab7b 
…ssue/pr templates
@nhunzaker
Copy link
Contributor

I kind of did:

Add an overview for each subsection (ie. Introduction, Api, Addons, etc)

What do you think?

@leobauza
Copy link
Contributor Author

Yeah, the only thing missing is an explanation of the difference between API and Addon. That is that the Addons are specific to react and API doesn't depend on a framework. But yeah your overviews pretty much covered what we needed. The quickstart or architecture section can make the division clearer when introducing concepts.

@leobauza
Copy link
Contributor Author

Closing and moving to the road to JSDoc #316

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@leobauza leobauza

Labels
documentation Site
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nhunzaker @leobauza