chore: add docs update status and health check #499
Conversation
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
Sita04
changed the title
| @@ -0,0 +1,112 @@ | |||
| <!-- BEGIN_DOCS_HEALTH_REPORT --> | |||
| # Sample Documentation Health Report | |||
There was a problem hiding this comment.
Do we want to call this "Sample" since we are publishing this? Maybe date it?
Documentation Health Report - July 2025
| @@ -1,3 +1,7 @@ | |||
| --- | |||
| version: 1.0.0 | |||
There was a problem hiding this comment.
Is this going to be visible on the page? Also: because this number looks like a version number for ADK, I think at least some people are going to assume that it corresponds with a ADK version number, in which case this makes it look like the docs are way out of date. Maybe it's better to display a last updated date and keep the version as hidden metadata?
There was a problem hiding this comment.
+1, the version is a bit confusing.
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.
Automation for Documentation Management:
.github/workflows/docs-health-check.yaml: Added a scheduled workflow to run a documentation health check every Sunday at midnight. The workflow generates a health report and creates a pull request if changes are detected..github/workflows/version-check.yaml: Added a workflow triggered on pull request events to generate a version report for documentation pages. It commits and pushes changes if the report is updated.Documentation Enhancements:
docs/agents/index.md: Introduced metadata for versioning (version: 1.0) in the front matter of the documentation page.docs_health_report.md: Added sample reports for documentation health and versioning, providing summaries and detailed insights into stale pages and version metadata.Website Improvements:
overrides/main.html: Enhanced the website template to display version information for pages with metadata, improving user awareness of documentation versions.Scripts for Reporting:
scripts/check_docs_health.py: Implemented a script to analyze documentation health based on update frequency, generating a detailed report for stale and recently updated pages.scripts/generate_version_report.py: Added a script to scan documentation files for version metadata and generate a comprehensive version report, including pages without version information.