-
Notifications
You must be signed in to change notification settings - Fork 81
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 Getting Started Guide #925
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
@@ Coverage Diff @@
## devel #925 +/- ##
==========================================
- Coverage 36.57% 36.39% -0.18%
==========================================
Files 42 42
Lines 7878 7878
==========================================
- Hits 2881 2867 -14
- Misses 4826 4838 +12
- Partials 171 173 +2 |
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.
Thanks for adding this guide!
Beyond the suggestions here, you need to add the new guide to source/index.rst. I suggest right after the install:
getting_started_guide/index
Then one of the CI tests will show readthedocs and if you click details, it will give you a preview of your docs. Very helpful to see it visually and pick up any stray problems.
2483913
to
11821fc
Compare
891f80e
to
ec53883
Compare
ec53883
to
c7656e5
Compare
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.
we can now see the preview in the ci tests, so here's a few more items to fix.
There is a strange problem where if I click the user guide in the preview site, the getting started guide disappears... let's see what happens after fixing these few nits.
b1e526b
to
ba92f3a
Compare
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.
LGTM
6f5149f
to
26de883
Compare
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.
lgtm
61987a6
to
f6e469d
Compare
Quality Gate passedIssues Measures |
No description provided.