Hoop Inspector DOCs - #153
Merged
Merged
Conversation
✅ Deploy Preview for decap-documentation ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
PR Summary by QodoAdd hoop-inspect documentation section to setup/configuration
AI Description
Diagram
High-Level Assessment
Files changed (4)
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Code Review by Qodo
Context used✅ Compliance rules (platform):
11 rules✅ Cross-repo context Explored:
repo: hoophq/hoop (sha: c3c56001) Not relevant to this PR:
hoophq/changelog 1. Future-facing note in Identity
|
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
Comment on lines
+443
to
+445
| Every session records `principal: anonymous` unless a deployment fills it. The plumbing runs end to end: the session carries a subject, and the proxy exposes a seam a deployment fills from a verified JWT, an mTLS peer cert or a credential token. A listener names its `identity_header`, and the current implementation contributes only the peer address. | ||
|
|
||
| Until that function is written, a Rego policy keyed on `input.context.user` reads `anonymous` from every lane. |
There was a problem hiding this comment.
1. Future-facing note in identity 📘 Rule violation ✧ Quality
The new docs include an internal/future-facing statement (Until that function is written...) rather than describing current product behavior. This can mislead readers about what identity/principal support exists today.
Agent Prompt
## Issue description
`setup/configuration/hoop-inspect/components.mdx` includes an internal/future-facing note (`Until that function is written...`) which violates the requirement that docs reflect current product behavior and avoid internal roadmap/implementation notes.
## Issue Context
The docs should describe what the system does now (and, if needed, document current limitations) without implying incomplete internal work.
## Fix Focus Areas
- setup/configuration/hoop-inspect/components.mdx[441-446]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
Comment on lines
+74
to
+76
| ```bash | ||
| hoop start inspect --config config.yaml --validate | ||
| ``` |
There was a problem hiding this comment.
3. Cli docs command mismatch 🔗 Cross-repo conflict ≡ Correctness
The new hoop-inspect docs instruct users to run hoop start inspect --config ... --validate, but the pinned hoophq/hoop CLI only defines hoop start agent and hoop start gateway (no inspect subcommand, and no --config/--validate flags). Users following these docs against the current Hoop CLI will get “unknown command/unknown flag” errors unless the CLI surface is added in hoophq/hoop and released in coordination with these docs.
Agent Prompt
## Issue description
The documentation repo now publishes commands for a `hoop start inspect` subcommand (`--config`, `--validate`) that is not present in the pinned `hoophq/hoop` CLI snapshot. This breaks the docs↔CLI contract: users cannot execute the documented commands.
## Issue Context
In `/cross_repos/hoop` (pinned), `hoop start` only exposes `agent` and `gateway` subcommands.
## Fix Focus Areas
- setup/configuration/hoop-inspect/get-started.mdx[70-94]
- setup/configuration/hoop-inspect/config-file.mdx[442-448]
## What to change
Choose one coordinated path:
1) **If hoop-inspect is not yet shipped in `hoophq/hoop`:**
- Update these docs to reflect currently available CLI commands, or clearly mark the feature as unreleased/preview and remove/replace the `hoop start inspect ...` invocations.
2) **If hoop-inspect is intended to be shipped:**
- Coordinate a `hoophq/hoop` change that adds `hoop start inspect` with the documented flags (`--config`, `--validate`) and then only publish these docs once that CLI release is available.
Keep the docs and CLI behavior consistent for the same released version.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
p3rotto
approved these changes
Jul 30, 2026
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
2 participants
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.
No description provided.