Skip to content

Commit cbacf4c

Browse files
committed
docs: reorganize README
1 parent 4458cca commit cbacf4c

2 files changed

Lines changed: 37 additions & 19 deletions

File tree

README.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -103,28 +103,10 @@ 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 report:github-docs`
118-
- `npm run docs-watch:local` (check + readable diff + run report)
119-
120-
Local outputs default to `.tmp/docs-watch/`, including `.tmp/docs-watch/docs-watch-report.md`.
121-
122-
Recommended weekly automation: run `npm run docs-watch:local`, review `.tmp/docs-watch/docs-watch-report.md` for correctness, then have Codex classify impact and open a draft fix PR when project changes are required.
123-
124106

125107
## Disclaimer
126108

127-
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.
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.
128110

129111
## License
130112

docs/MAINTAINERS.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,42 @@ regressions and to verify the poller and post hook behave as expected.
9393
- If diagnostics are disabled in the action input, the self-test diagnostics
9494
jobs will not have artifacts to download and will fail.
9595

96+
## Docs-watch maintenance
97+
98+
The docs-watch process is local-only and intended for maintainers.
99+
100+
- Do not store upstream GitHub documentation bodies in this public repository.
101+
- Monitored metadata files live in `docs/github-documentation/*.md`.
102+
- Local private state defaults to `.tmp/docs-watch/state` and stores snapshots
103+
used for diffing.
104+
105+
### Local commands
106+
107+
- Seed or refresh baseline snapshots:
108+
- `npm run sync:github-docs-state`
109+
- Run check + diff + report (standard weekly run):
110+
- `npm run docs-watch:local`
111+
- Individual steps:
112+
- `npm run check:github-docs`
113+
- `npm run diff:github-docs`
114+
- `npm run report:github-docs`
115+
116+
### Run artifacts
117+
118+
- Check payload: `.tmp/docs-watch/docs-check.json`
119+
- Unified diff markdown: `.tmp/docs-watch/docs-diff.md`
120+
- Unified diff patch: `.tmp/docs-watch/docs-diff.patch`
121+
- Always-on run report (generated every run): `.tmp/docs-watch/docs-watch-report.md`
122+
123+
### Maintainer review loop
124+
125+
1. Run `npm run docs-watch:local` (or let weekly Codex automation run it).
126+
2. Review `.tmp/docs-watch/docs-watch-report.md` for correctness.
127+
3. If docs changed, validate impact classification and decide if project updates
128+
are required.
129+
4. If required, open/update a draft fix PR with project and metadata changes
130+
only.
131+
96132
## Notes
97133

98134
- `CHANGELOG.md` is generated by Release Please; avoid manual edits.

0 commit comments

Comments
 (0)