feat(docs): audit config keys and console commands for coverage gaps - #1
Open
lessevv wants to merge 1 commit into
Open
feat(docs): audit config keys and console commands for coverage gaps#1lessevv wants to merge 1 commit into
lessevv wants to merge 1 commit into
Conversation
Adds docs:audit-coverage, which cross-references each platform's config keys and console commands (fetched from the package's GitHub repo tree) against the docs markdown, flagging anything never mentioned by name. Results persist to a docs_coverage_gaps table, surfaced to maintainers via an admin-only Filament resource, and the command runs weekly. Extends App\Support\GitHub with tree()/blob() (Git Trees/Blobs API) and authenticates its requests when a GitHub token is configured, since the per-file blob fetches this adds can otherwise exhaust the 60/hour unauthenticated rate limit in a single run. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
1 participant
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.
Summary
Adds a
docs:audit-coverageArtisan command (run weekly) that cross-references each platform's config keys and console commands — fetched from the package's GitHub repo tree — against the docs markdown, flagging anything never mentioned by name. Results persist to a newdocs_coverage_gapstable, surfaced to maintainers via an admin-only Filament resource ("Docs Coverage").App\Support\GitHubwithtree()/blob()(Git Trees/Blobs API), authenticated when a GitHub token is configured — the per-file blob fetches this adds can otherwise exhaust the 60/hour unauthenticated rate limit in a single run.config('docs.source_repos'), read throughDocsVersionRegistry, matching this PR's existing config-driven pattern.Depends on NativePHP#498 — targets that branch rather than main.
🤖 Generated with Claude Code