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

Create Basic Documentation for Project #51

Open
katjone opened this issue Nov 14, 2019 · 1 comment
Open

Create Basic Documentation for Project #51

katjone opened this issue Nov 14, 2019 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@katjone
Copy link
Contributor

katjone commented Nov 14, 2019

Add a wiki or docs folder or extend our existing README for our project to hold additional documentation for the following:

  • Project MVP with user stories, wireframes ( link to Figma?), and technologies we are using

  • Explanation of site features, current and planned

  • Any other relevant documentation / resource links, useful info

  • Onboarding

Also, link to this wiki / docs from our project README

@katjone katjone added the documentation Improvements or additions to documentation label Nov 14, 2019
@katjone katjone changed the title Create Wiki for Project Create Basic Documentation for Project Nov 14, 2019
@katjone
Copy link
Contributor Author

katjone commented Nov 19, 2019

Current idea:

README - front page

Use README as sort of book cover/ front page of the project which will contain an introduction and explanation of the project, as well as a 'get involved' section directing potential contributors to the project Wiki.

The Wiki

Here is where contributors can see innards of project, including project materials, an onboarding guide (for developers), our tech stack, and just more detailed information on how to contribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant