Skip to content

Commit 5c3a9b1

Browse files
committed
chore: switch docs watch to local-only automation
1 parent 477dba9 commit 5c3a9b1

10 files changed

Lines changed: 420 additions & 670 deletions

File tree

.github/workflows/github-doc-watch.yml

Lines changed: 0 additions & 81 deletions
This file was deleted.

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,3 +133,8 @@ temp/
133133
INTERNAL
134134

135135
docs/planning/
136+
137+
# Docs watch private/runtime artifacts
138+
docs/github-documentation/docs-check.json
139+
docs/github-documentation/docs-diff.md
140+
docs/github-documentation/docs-diff.patch

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,27 @@ Windows is not supported (the action will fail fast with a clear error).
103103
- GitHub's primary rate limits appear to use fixed windows with reset times anchored to the first observed usage of the token (per resource bucket), rather than a rolling window. For `core`, e.g., this is 60 minutes from the first usage within an action. For other buckets, such as `search` the reset window is 60 seconds from the time of first use. (See [this document](./docs/RATE_LIMIT_TABLE.md) for a bucket-by-bucket breakdown.)
104104
- What happens after this reset window is crossed is that the "Amount Remaining" data is reset to the maximum for that bucket, and the "Reset Time" is also reset to the full reset-window duration from the time of polling. This is a major design constraint on an action such as the current one, because a polling-based measurement must be designed such that the gap between the last poll and the next reset time is minimized - any activity that happens after a given poll, and before the next reset, will be invisible to the poller. That is the justification for the strategy of 30-second polling, with some "extra polls" at the designated reset time - this allows for high-confidence tracking of API requests to buckets with 60-second reset windows.
105105

106+
## GitHub Docs Watch
107+
108+
This repository uses a local-only docs-watch flow.
109+
110+
Important copyright constraint: upstream GitHub docs bodies are **not** stored in this public repository. The tracked files under [`docs/github-documentation`](./docs/github-documentation) are metadata-only.
111+
112+
Local commands:
113+
114+
- `npm run sync:github-docs-state` (seed or refresh private baseline snapshots)
115+
- `npm run check:github-docs`
116+
- `npm run diff:github-docs`
117+
- `npm run docs-watch:local` (check + readable diff)
118+
119+
Local outputs default to `.tmp/docs-watch/`.
120+
121+
Recommended weekly automation: run `npm run docs-watch:local`, then have Codex review `.tmp/docs-watch/docs-diff.md`, classify impact, and open a draft fix PR when project changes are required.
122+
106123

107124
## Disclaimer
108125

109-
The statements made in this document, and the implementation decisions in the code, are made in strict adherence to the GitHub API and Actions documentation at the time of writing. In addition, our CI processes regularly check for updates to the core documents. Best efforts have been made for strict compliance with GitHub's policy recommendations and guidelines - however, we accept no responsibility for any penalties incurred by the use of this action.
126+
The statements made in this document, and the implementation decisions in the code, are made in strict adherence to the GitHub API and Actions documentation at the time of writing. In addition, our CI processes regularly check for updates to the core documents using metadata-only tracking in this public repository and private-state diffs for detailed review. Best efforts have been made for strict compliance with GitHub's policy recommendations and guidelines - however, we accept no responsibility for any penalties incurred by the use of this action.
110127

111128
## License
112129

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# GitHub Docs Watch Metadata
2+
3+
This directory stores **metadata only** for monitored GitHub documentation pages.
4+
5+
Copyright policy constraint: upstream GitHub documentation bodies are intentionally not committed in this public repository.
6+
7+
## Files
8+
9+
- `rate-limit.md` and `rate-limits-for-the-rest-api.md`: frontmatter metadata (`redirect-link`, `content-sha256`) used for change detection.
10+
- No upstream Markdown body text is stored here.
11+
12+
## Private state (required for full diff + LLM review)
13+
14+
Readable diffs require a private local state directory that stores snapshot bodies outside this public repo.
15+
16+
Example local state location:
17+
18+
- `.tmp/docs-watch/state` (default for local scripts)
19+
20+
## Local workflow
21+
22+
1. (Optional, first run) `npm run sync:github-docs-state`
23+
2. `npm run check:github-docs`
24+
3. `npm run diff:github-docs`
25+
4. Ask Codex to review `.tmp/docs-watch/docs-diff.md` and classify project impact.
26+
27+
Outputs are written under `.tmp/docs-watch/` by default.

docs/github-documentation/docs-check.json

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)