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.

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

Update readme #201

Merged
merged 6 commits into from
May 16, 2019
Merged

Update readme #201

merged 6 commits into from
May 16, 2019

Conversation

f-f
Copy link
Member

@f-f f-f commented May 15, 2019

Description of the change

@JordanMartinez
Copy link
Contributor

@f-f Alex and I read through that very helpful post, but we also read through a number of other resources. I'm not sure whether you'd be interested in it, but we summarized our conclusions here

@f-f
Copy link
Member Author

f-f commented May 15, 2019

@JordanMartinez thanks, that's a nice read too! 👏

@f-f f-f merged commit c5ea3d0 into master May 16, 2019
@f-f f-f deleted the rewrite-readme branch May 16, 2019 06:08
elliotdavies pushed a commit to elliotdavies/spago that referenced this pull request Jul 1, 2019
Heavily update the README following some very good guidelines on writing 
technical documentation: https://www.divio.com/blog/documentation/

Now documented things are split between parts with different needs/tone
instead of being in a single giant tutorial:
  - "Tutorial"
  - "Howto"
  - "Explanation"
  - "Troubleshooting"
@f-f f-f mentioned this pull request Aug 29, 2019
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants