489 add documentation #519
Conversation
TODO: Review and see with project lead if more info is appropriate.
Added README and documentation markdown files for several common components (GitHubButton, SingleProfInfo, Split, StickySide, WhatsNew) and expanded the SingleGradesInfo README with usage examples. Updated ESLint and Prettier dev dependencies to latest versions in package.json, but left out of commit.
I used `npm run format` and `npm run lint` to properly format the documents I edited to pass the project checkers.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Hey @YadValRio my sincere apologies for the super super late response! These look really good, thank you for your work! Just FYI, in the code samples we generally try to use the component directly rather than recreating so we have a reference on its use that we won't need to update every time something inside the component changes. I made a couple of updates to the samples based on this; sorry for not letting you know abt that earlier, I understand there were a couple of tricky spots in these components. If you could look over the changes I made and try to update the last code sample -- for SingleGradesInfo-- along the same lines yourself that would be great! Or let me know if you'd rather I finish it up, sorry again for responding so late! |
Overview
Added documentation to following components:
Github Button
SingleGradesInfo
SingleProfInfo
Split
StickySide
WhatsNew
What Changed
Added a brief description, props table, and brief code example