Skip to content
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

docs: Initial user facing docs #276

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

jannfis
Copy link
Collaborator

@jannfis jannfis commented Jan 14, 2025

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-docs to start a local RTD container to view the documentation.

Checklist

  • Documentation update is required by this PR (and has been updated) OR no documentation update is required.

@codecov-commenter
Copy link

codecov-commenter commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.32%. Comparing base (d4f380d) to head (d82e61e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #276      +/-   ##
==========================================
+ Coverage   48.20%   48.32%   +0.11%     
==========================================
  Files          55       55              
  Lines        5066     5066              
==========================================
+ Hits         2442     2448       +6     
+ Misses       2424     2417       -7     
- Partials      200      201       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jannfis jannfis force-pushed the docs/initial-user-facing-docs branch from 11621f4 to 230a827 Compare January 14, 2025 15:35
@jannfis jannfis changed the title docs: Skeleton for user facing docs docs: Initial user facing docs Jan 14, 2025
@jannfis jannfis force-pushed the docs/initial-user-facing-docs branch from f3ece22 to 097e6d8 Compare January 14, 2025 21:16
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants