Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #28 +/- ##
=======================================
Coverage 93.69% 93.69%
=======================================
Files 16 16
Lines 1348 1348
=======================================
Hits 1263 1263
Misses 85 85 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Adds a MkDocs-based documentation site (including API reference via mkdocstrings) and wires up GitHub Pages deployment as part of the release workflow.
Changes:
- Add MkDocs configuration + initial docs pages (usage + API reference stubs).
- Add a
docsdependency group and enrichproject.urlsmetadata. - Add GitHub Pages build/deploy jobs to the release workflow.
Reviewed changes
Copilot reviewed 10 out of 12 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
pyproject.toml |
Adds docs dependency group and expands well-known project URLs. |
mkdocs.yml |
Defines MkDocs site config (nav, theme, mkdocstrings, extensions). |
docs/index.md |
Adds the docs landing page content source. |
docs/usage.md |
Documents CLI usage and a basic Python API example. |
docs/sip.md |
Adds SIP API reference page using mkdocstrings directives. |
docs/rtp.md |
Adds RTP API reference page using mkdocstrings directives. |
docs/calls.md |
Adds call handling API reference page. |
docs/images/logo-light.svg |
Tweaks logo styling. |
docs/images/icon.svg |
Adjusts icon fill behavior for MkDocs theme usage. |
README.md |
Minor README footer/link line tweak. |
CONTRIBUTING.md |
Adds instructions for building/serving docs locally. |
.github/workflows/release.yml |
Adds Pages build + deploy jobs alongside PyPI release jobs. |
You can also share your feedback on Copilot code review. Take the survey.
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
This file contains hidden or 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
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.
No description provided.