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

Ensure ReadMe no longer contains outdated development notes, and is ready for public use. (docs) #83

Open
alodahl opened this issue Sep 13, 2020 · 3 comments
Labels
backend GHC2020 Project 🛑 blocked Waiting on one or more issues to be merged documentation Priority 5 Clean up tasks

Comments

@alodahl
Copy link
Collaborator

alodahl commented Sep 13, 2020

Ensure ReadMe no longer contains outdated development notes, and is ready for public use. (docs)

For example:

if there are wireframes or notes about a future feature, but that feature has been completed, remove it or convert it to notes about how to use the existing feature.

All available API endpoints should be listed in the readme.

Any useful commands in the packages json should be listed in the readme.

@alodahl alodahl added backend GHC2020 Project documentation GraceHopperOSD Reserved for GHC Open Source Day! Priority 5 Clean up tasks labels Sep 13, 2020
@vegetabill vegetabill added the 🛑 blocked Waiting on one or more issues to be merged label Oct 1, 2020
@alodahl alodahl removed the GraceHopperOSD Reserved for GHC Open Source Day! label Oct 3, 2020
@rajatRS
Copy link

rajatRS commented Oct 7, 2020

I would like to take up this issue. :)
It would be great if you give a small example what you want to include in your readme so that I may get a better hand.

@alodahl
Copy link
Collaborator Author

alodahl commented Oct 8, 2020

Hi @rajatRS , it looks like this issue is blocked pending some other work. Please consider #39 , #136 , or a To Do issue in our other repo: https://github.com/Techtonica/curriculum/projects/2.

@rajatRS
Copy link

rajatRS commented Oct 8, 2020

@alodahl Sorry, my bad :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend GHC2020 Project 🛑 blocked Waiting on one or more issues to be merged documentation Priority 5 Clean up tasks
Projects
None yet
Development

No branches or pull requests

3 participants