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

Simplify README documentation #101

Closed
dimberman opened this issue Feb 10, 2022 · 2 comments
Closed

Simplify README documentation #101

dimberman opened this issue Feb 10, 2022 · 2 comments
Assignees
@tatiana
Labels
documentation Improvements or additions to documentation priority/high High priority
Milestone
0.7.x

Comments

@dimberman
Copy link
Collaborator

dimberman commented Feb 10, 2022 •
edited

Acceptance criteria:

  • User should be able to read README page in two minutes
  • Documentation should follow the guidelines outlined here

https://documentation.divio.com/
https://www.youtube.com/watch?v=t4vKPhjcMZg
https://diataxis.fr/
@dimberman dimberman added documentation Improvements or additions to documentation priority/high High priority labels Feb 10, 2022
@tatiana tatiana added this to the 0.6.0a1 milestone Feb 21, 2022
@tatiana tatiana self-assigned this Feb 21, 2022
@tatiana tatiana modified the milestones: 0.6.0, 0.6.1 Mar 1, 2022
@tatiana tatiana mentioned this issue Mar 3, 2022
Merged
@tatiana
Copy link
Collaborator

tatiana commented Mar 3, 2022

I pushed the changes to the README - still working on them:
https://github.com/astro-projects/astro/tree/readme

tatiana added a commit that referenced this issue Mar 4, 2022
@tatiana
Refactor README (#101)
bebd24f
@tatiana
Copy link
Collaborator

tatiana commented Mar 4, 2022

Ready for review: #157

@tatiana tatiana mentioned this issue Mar 4, 2022
Merged
@tatiana tatiana closed this as completed Mar 4, 2022
utkarsharma2 pushed a commit that referenced this issue Mar 30, 2022
@tatiana @utkarsharma2
Refactor README (#101)
89cebb8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tatiana tatiana

Labels
documentation Improvements or additions to documentation priority/high High priority
Projects
None yet
Milestone
0.7.x
Development

No branches or pull requests
2 participants
@tatiana @dimberman