FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs(events,mutations,platform_metrics): add API reference pages by ernesthenry · Pull Request #34 · pythonnative/pythonnative · GitHub

Repository navigation

docs(events,mutations,platform_metrics): add API reference pages - #34

Closed
ernesthenry wants to merge 1 commit into
pythonnative:mainfrom
ernesthenry:docs/api-reference-pages
Closed

ernesthenry wants to merge 1 commit into
pythonnative:mainfrom
ernesthenry:docs/api-reference-pages

Conversation

Copy link
Copy Markdown
Contributor

What

  • Add API reference pages for pythonnative.events, pythonnative.mutations, and pythonnative.platform_metrics.
  • Wire the new pages into the API Reference section of mkdocs.yml.
  • De-duplicate embedded blocks in docs/api/native_views.md in favor of dedicated pages.

Why

  • These modules had docstrings ready for mkdocstrings but were missing standalone pages in the API reference.

How (brief)

  • Created docs/api/events.md, docs/api/mutations.md, and docs/api/platform_metrics.md with module intros, mkdocstrings directives (filters: ["!^_"]), and "Next steps" cross-links.
  • Updated mkdocs.yml navigation to include the three new pages.
  • Verified that mkdocs build --strict builds cleanly with zero warnings or broken references.

Testing

  • Ran mkdocs build --strict locally; site builds cleanly in strict mode.

Risks/Impact

  • Low risk; documentation only.

Docs/Follow-ups

  • None required.

Closes #24

Copy link
Copy Markdown
Contributor

Thanks for taking the time to put this together. Unfortunately this one's a duplicate: issue #24 was claimed and assigned on Aug 30, and PR #31 (opened before this one) covered the same changes and has since merged, which is why the issue is now closed. I'm going to close this PR as superseded.

Sorry the effort didn't land this time. To avoid a repeat, please comment on an issue to claim it and wait for assignment before starting work; the assignee and linked PRs on the issue are the quickest way to see whether it's taken. We just opened ten new good first issues (#36-#45), and several are in the same areas you touched here. If one interests you, comment on it and I'll assign it to you.

owenthcarey closed this Sep 1, 2026
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add API reference pages for events, mutations, and platform_metrics

2 participants


Back | FazBrowse Home | New Git URL