docs: document gh_api sentinel contract and gh_api_paginate across all docs#27
Merged
Conversation
…l docs - lib/github-common.sh: rewrite # Provides: header block — fix scrambled layout, add get_repo_page_count, document __404__/__422__ sentinel contract on gh_api, and note gh_api_paginate empty-output behaviour - README.md: add configure_gh_auth to its own Auth helpers section; add gh_api_paginate to API helpers; clarify gh_api sentinel contract; move validate_slug to Validation section - AGENTS.md: update gh_api and gh_api_paginate table rows to describe sentinel contract; add sentinel note to Rate limiting section - copilot-instructions.md: update gh_api rate-limiting bullet to include sentinel contract; update github-dockerfile-discovery description to document both gh_api call sites' sentinel handling; add gh_api_paginate row to maintenance matrix Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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
The final review found four documentation gaps — all docs-only fixes, no code changes.
Changes
lib/github-common.sh—# Provides:header block rewritten:get_repo_page_countentry__404__/__422__sentinel contract togh_apigh_api_paginateempty-output-on-404/422 noteREADME.md— Available Functions section:configure_gh_auth(was missing entirely)gh_api_paginate(was missing entirely)validate_slugto the Validation groupgh_apisentinel note (literal string, exit 0, callers must check before jq)AGENTS.md— shared library table and rate-limiting section:gh_apiandgh_api_paginaterows to describe sentinel behaviour.github/copilot-instructions.md— three locations:github-dockerfile-discoverydescription: documented bothgh_apicall sites and their sentinel handlinggh_api_paginatecallers (github-repo-permissions-report,github-copilot-report)