docs: Initial user facing docs #276
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jannfis
requested review from
jgwest,
ishitasequeira and
chetan-rns
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #276 +/- ##
==========================================
- Coverage 48.55% 48.52% -0.04%
==========================================
Files 73 73
Lines 6314 6314
==========================================
- Hits 3066 3064 -2
- Misses 2983 2985 +2
Partials 265 265 ☔ View full report in Codecov by Sentry. |
jannfis
force-pushed
the
docs/initial-user-facing-docs
branch
from
11621f4 to
230a827
Compare
jannfis
changed the title
Signed-off-by: jannfis <[email protected]>
jannfis
force-pushed
the
docs/initial-user-facing-docs
branch
from
f3ece22 to
097e6d8
Compare
Signed-off-by: jannfis <[email protected]>
Signed-off-by: jannfis <[email protected]>
Signed-off-by: jannfis <[email protected]>
Signed-off-by: jannfis <[email protected]>
Signed-off-by: jannfis <[email protected]>
Signed-off-by: jannfis <[email protected]>
chetan-rns
reviewed
Jan 27, 2025
|
@chetan-rns Thanks for reviewing. Yes, as stated, it's still incomplete but will allow us to move forward in further incremental changes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do / why we need it:
This PR introduces initial user facing docs, ready to be rendered by readthedocs.org.
It's by far not complete or really valuable to users yet, but it allows us to setup the RTD instance, GitHub actions rendering and is ready for further contributions.
Which issue(s) this PR fixes:
Fixes #?
How to test changes / Special notes to the reviewer:
You can checkout the PR's code and run
make serve-docsto start a local RTD container to view the documentation.Checklist