Repository navigation
Docs-site runbook goes internal; Coach API scope tables match the resolver - #43
Merged
Merged
Conversation
guides/deployment.mdx carried the DNS record, the Cloudflare proxy rule, the Mintlify rebuild steps and the docs.json settings for docs.saturday.fit itself, and named the docs repository. That is operator material, not something a partner building against the API needs. It now lives in DEPLOY.md at the repository root, with a pointer from the README. The public page is replaced by guides/documentation.mdx, one paragraph on where the docs are published, that they describe the current /v1 API and that the API root links back to them, where the llms.txt files are, and how to report a documentation error. docs.json navigation points at the new page and a redirect keeps /guides/deployment resolving. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01K9f7KoPEPs8FXwBT8vAduy Ci-From: linux Ci-Session: f2e28bc2-ac58-48e1-a2b8-39bf8e777e80
The scope table omitted reports:read entirely and left org:admin out of every row, so a coach reading it could not see that org:admin reaches the whole surface or that reports:read alone opens the report routes. The section now carries two tables built from pkg/coachscope/capabilities.go and the /v1/coach/* route registrations: capability to OAuth scope to the exact endpoints, and API-key scope to the capabilities it confers, all seven scopes plus the legacy "*". It also states that reading config takes the same capability as writing it, which the route gates enforce. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01K9f7KoPEPs8FXwBT8vAduy Ci-From: linux Ci-Session: f2e28bc2-ac58-48e1-a2b8-39bf8e777e80
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
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.
What changes on the site
/guides/deploymentleaves the public site. It carried the DNS record, the Cloudflare proxy rule, the Mintlify rebuild steps and the docs.json settings for docs.saturday.fit itself, and named the docs repository: operator material, not something a partner building against the API needs./guides/documentationtakes its place with one paragraph: where the docs are published, that they describe the current/v1API and the API root links back to them, where the llms.txt files are, and how to report a documentation error. Adocs.jsonredirect keeps/guides/deploymentresolving; nothing else on the site linked to it.reports:readentirely and leftorg:adminout of every row, so a coach could not see thatorg:adminreaches the whole surface or thatreports:readalone opens the report routes. Two tables now, built from fuel-backendpkg/coachscope/capabilities.goand the/v1/coach/*route registrations incmd/partner-api: capability to OAuth scope to the exact endpoints, and API-key scope to the capabilities it confers, all seven scopes plus the legacy*. It also states that reading config takes the same capability as writing it, which the route gates enforce.Where the runbook went
DEPLOY.mdat the repository root, with a pointer from the README. The repository is public, so the file stays readable in git and in history; nothing in it is a secret (the CNAME target is whatdiganswers, the colors are in docs.json). It is off the published site and out ofllms-full.txt.Checks, run locally on this tree
scripts/check-docs-drift.py --backend fuel-backend@01e0c7escripts/check-engine-constants.pyscripts/test-response-examples.pynpx mint@latest validatenpx mint@latest broken-links --check-anchors --check-externalCI
The Docs Drift workflow asks for the self-hosted runner, which does not take jobs from this public repository, so its run queues indefinitely rather than failing. The drift check above is that same script run locally against fuel-backend main. Engine Constants and its self-test are the runs to watch.
🤖 Generated with Claude Code
https://claude.ai/code/session_01K9f7KoPEPs8FXwBT8vAduy