-
Notifications
You must be signed in to change notification settings - Fork 3
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
Add docs #107
Conversation
Your Render PR Server URL is https://cyfi-pr-107.onrender.com. Follow its progress at https://dashboard.render.com/static/srv-ckebrmmnpffc73a08ikg. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ejm714 these are excellent!! Extremely easy to follow, well written, and covers all the key pieces of information. I love it!
Most of my comments are copy editing, and are up to you whether to incorporate.
Co-authored-by: Katie Wetstone <46792169+klwetstone@users.noreply.github.com>
Co-authored-by: Katie Wetstone <46792169+klwetstone@users.noreply.github.com>
Co-authored-by: Katie Wetstone <46792169+klwetstone@users.noreply.github.com>
Co-authored-by: Katie Wetstone <46792169+klwetstone@users.noreply.github.com>
Co-authored-by: Katie Wetstone <46792169+klwetstone@users.noreply.github.com>
Co-authored-by: Katie Wetstone <46792169+klwetstone@users.noreply.github.com>
Co-authored-by: Katie Wetstone <46792169+klwetstone@users.noreply.github.com>
Co-authored-by: Katie Wetstone <46792169+klwetstone@users.noreply.github.com>
Co-authored-by: Katie Wetstone <46792169+klwetstone@users.noreply.github.com>
Thanks for the comments @klwetstone! Could you take the two outstanding items? I think it'd be nice to add some kind of visual. I was thinking on the home page but that likely puts the quickstart too far below the fold so maybe an image is better on the about page. Also you can make the dataframes tables in html and that will render fine. If you just use the markdown table format, they get assigned 100% width (and we should use auto width sizing so this works across screen types) so you may want to fiddle with the css in |
@ejm714 Done!
Two questions:
|
Thanks @klwetstone -- I made the following adjustments
|
@ejm714 This all looks great! Especially the homepage -- much better. I just made a few tiny tweaks:
I also checked all the external links and all of them worked. I noticed that links to other pages within the documentation are a mix of relative paths (eg. the link to the quickstart page from I think this all looks EXCELLENT! Well done! |
I think the links are set up correctly but I made a note in #34 to double check once the docs are deployed. |
First pass at some docs
Outstanding:
add github actionsset up on renderCloses #66