Repository navigation
docs: document the history dashboard - #46
Merged
Merged
Conversation
README gets a "History" section (the /history page: sort/filter/download/ delete, and ENABLE_HISTORY to hide it on shared deployments). CLAUDE.md notes the /history, /history/delete and /history/clear endpoints and their guards.
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.
Problem
The history dashboard (PR #45) shipped without user/agent docs.
Change
Historysection under Usage: what/historyshows, sort/filter/download/delete, and theENABLE_HISTORYflag to hide it (and its delete endpoints) on a shared/exposed deployment.GET /history,POST /history/delete,POST /history/clear(refuse in-flight jobs; 404 whenENABLE_HISTORY=False).Docs only — no code change.
ENABLE_HISTORYis already in.env.example.Evidence
pytest— 68 passed (unchanged; docs-only).