Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/changelog-fragment-guard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ jobs:
src/scripts/check-changelog-fragment.sh "$BASE_REF"


# api-reference.md `pkg/<file>:<line>` citations go stale when a PR edits
# api-reference/*.md `pkg/<file>:<line>` citations go stale when a PR edits
# a route-registering server.go. The `relative links and anchors resolve`
# job reports that too, but it is not a required check, so the causing PR
# merged red and every later PR inherited the failure (#11866). This
Expand All @@ -157,7 +157,7 @@ jobs:
exit 0
fi
if ! bash src/scripts/check-api-reference-citations.sh; then
echo "::error::This PR edited a server.go or static pages and src/docs/api-reference.md citations drifted. Run 'bash src/scripts/check-api-reference-citations.sh --fix' and commit the result. If static pages under src/pkg/dashboard/ also changed, lower the matching baseline in src/pkg/dashboard/webstatic/style_ratchet_test.go (styleRatchetBaselines) in the same PR."
echo "::error::This PR edited a server.go or static pages and src/docs/api-reference/ citations drifted. Run 'bash src/scripts/check-api-reference-citations.sh --fix' and commit the result. If static pages under src/pkg/dashboard/ also changed, lower the matching baseline in src/pkg/dashboard/webstatic/style_ratchet_test.go (styleRatchetBaselines) in the same PR."
exit 1
fi

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docs-link-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,12 @@ jobs:
- name: Check src/docs/ relative links and anchors
run: python3 src/scripts/check-docs-links.py src/docs

# Verifies every `pkg/<file>:<line>` citation in api-reference.md still
# Verifies every `pkg/<file>:<line>` citation in api-reference/*.md still
# points at the route registration it names (hivecommons/hive#6628).
- name: Self-test the api-reference citation checker
run: bash src/scripts/test-check-api-reference-citations.sh

- name: Check api-reference.md source citations
- name: Check API reference area source citations
run: bash src/scripts/check-api-reference-citations.sh

# Verifies repo-local file:line citations across every src/docs/*.md file
Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ These rules apply to every AI agent (hive agents, Copilot CLI, Claude Code, Code
- Keep changes surgical and PR-sized; one concern per PR.
- Every PR with a user-visible `src/` code change needs a `changelog.d/<category>-<slug>.md` fragment (`added|changed|deprecated|fixed|security`) whose body is a single `- ` bullet. Changes outside `src/` (root-level docs, `changelog.d/`, `.github/`), plus `src/docs/`, `*_test.go` files, and `src/{deploy,scripts}/test[-_]*.sh` scripts, are exempt automatically (`src/scripts/check-changelog-fragment.sh` is the source of truth for the exact set); other test-adjacent changes (e.g., `testdata/` fixtures, non-`_test.go` test helpers) and non-user-visible `src/` code changes (refactors, dependency bumps) need the `no-changelog` label instead. `changelog.d/` is at the repository root, not under `src/` β€” `src/changelog.d/` is never compiled and the guard rejects it.
- Sign commits (`git commit -s`); PR titles start with an emoji (`✨` feature, `πŸ›` fix, `πŸ“–` docs, `πŸ“` proposal, `🌱` chore, `⚠️` breaking) β€” `πŸ“` is for proposals only; a docs PR is `πŸ“– docs: …`.
- Do not hand-edit `src/docs` file:line citations (including `src/docs/api-reference.md`); when CI's citation guard reports drift, run `python3 src/scripts/check-docs-citations.py --fix` first β€” it runs `check-api-reference-citations.sh --fix` for `api-reference.md` and re-anchors other `.go` citations by their backticked Go declaration anchor. Only fall back to a manual edit for citations it still reports as `DRIFT`/`UNRESOLVED`, and run it only when CI tells you citations drifted. The required `changelog-fragment-guard` check runs it (non-fix) when a PR edits a hub or dashboard `server.go` or their `static/` pages, so the PR that causes drift goes red.
- Do not hand-edit `src/docs` file:line citations (including `src/docs/api-reference/*.md`); when CI's citation guard reports drift, run `python3 src/scripts/check-docs-citations.py --fix` first β€” it runs `check-api-reference-citations.sh --fix` for the `api-reference.md` index and its `api-reference/` area files and re-anchors other `.go` citations by their backticked Go declaration anchor. Only fall back to a manual edit for citations it still reports as `DRIFT`/`UNRESOLVED`, and run it only when CI tells you citations drifted. The required `changelog-fragment-guard` check runs it (non-fix) when a PR edits a hub or dashboard `server.go` or their `static/` pages, so the PR that causes drift goes red.
1 change: 1 addition & 0 deletions changelog.d/changed-15303-api-reference-areas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Split the API reference into focused area documents while preserving existing index anchors; citation checks and repairs now cover the index and all area files, continuing repairs in other areas when a citation cannot be resolved ([#15303](https://github.com/hivecommons/hive/pull/15303)).
Loading
Loading