Skip to content

Conversation

SandersAaronD
Copy link
Contributor

@SandersAaronD SandersAaronD commented Aug 7, 2025

This looks heavy but is entirely a fix for documentation and readability. Original intention was just to add badges, but adding the badges made it look like we were overdue to factor the CI into separate files and flesh out docstrings slightly more. Closes #232

- Enhanced function documentation with detailed descriptions explaining purpose and usage
- Added context about parameters, return values, and error conditions
- Improved type documentation for GrafanaConfig, TLSConfig, Tool, and ToolHandlerFunc
- Clarified the role of context functions in the MCP server lifecycle
- Added documentation for transport wrapper functions and version utilities
@SandersAaronD SandersAaronD requested a review from a team as a code owner August 7, 2025 00:00
@SandersAaronD SandersAaronD added documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code labels Aug 7, 2025
Copy link
Collaborator

@sd2k sd2k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@sd2k sd2k merged commit 52164c5 into main Aug 7, 2025
10 of 13 checks passed
@sd2k sd2k deleted the sandersaarond/add-badges branch August 7, 2025 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add some more badges (ci/cd, coverage, etc)
2 participants