Documentation #48
Documentation #48
Conversation
docs/Contributing.md
Outdated
| @@ -0,0 +1,63 @@ | |||
| # Contributing | |||
There was a problem hiding this comment.
rename to CONTRIBUTING.md (caps) and link to this file from the README
There was a problem hiding this comment.
I wanted to keep all the docs in the same format with camel case titles, for consistency. I know its not how its typically done, but I like it a bit better this way.
Added the link
There was a problem hiding this comment.
I dont think the link is present anymore
docs/HowToRun.md
Outdated
| @@ -0,0 +1,59 @@ | |||
| # How to Run | |||
There was a problem hiding this comment.
Thoughts on having this in the README instead? Personally I generally only want to have to look at the readme to find this information. I don't want to have to go searching through the project for docs like this.
There was a problem hiding this comment.
Normally, I would agree, however I want to approach this from the perspective of a student who has no web development experience. I want to have extensive instructions on how to run the app locally on each OS. My hope is that future students are able to make changes without our help.
For that reason I made it into its own separate file so we can lots of detail later on. Dont wanna include it in the README, because it might look ugly lol.
| You will also see any lint errors in the console. | ||
|
|
||
| `yarn test` | ||
|  |
There was a problem hiding this comment.
I still think we should add some links here to the docs stuff. looking at a git repo people will normally just look at the readme and not go searching for things, I have never assumed that the docs folder would hold docs for me as a potential contributor, but rather I often assume that they are docs that go along with the project.
There was a problem hiding this comment.
To be fair does anyone read the documentation XD. But as an alternative, what if we put everything in the wiki instead? Might be the option that makes the most sense, and include very basic instructions on how to run in the README?
There was a problem hiding this comment.
I agree wiki might be good for some of that, as long as there is at least a link to it from the readme, basic instructions in readme + more detail in wiki / docs works too (that is my preferred method). I really like readme's that include a quickstart then detailed usage is linked elsewhere
docs/Contributing.md
Outdated
| @@ -0,0 +1,63 @@ | |||
| # Contributing | |||
There was a problem hiding this comment.
I dont think the link is present anymore
|
Describe the pull request:
Let me know if there is anything else I should include in the docs.
Closes: #10
Fixes: #
Related: #42
Checklist:
AssigneeSoorajModias the reviewer