feat: POLICY-CONFIG-001 PR 8 — Policy configuration documentation#33
Merged
feat: POLICY-CONFIG-001 PR 8 — Policy configuration documentation#33
Conversation
New pages: - concepts/policy-scoping.md: Three-level scoping model (org → group → agent) - how-to/configure-agent-policy.md: YAML config walkthrough - reference/policy-config-yaml.md: Full YAML schema reference - reference/policy-api.md: Phase-one policy API reference Updated pages: - reference/cli/index.md: Added policy validate and policy context commands - concepts/enforcement.md: Added policy-driven enforcement section - mkdocs.yml: Added new pages to navigation
There was a problem hiding this comment.
Pull request overview
Adds MkDocs documentation pages for the YAML policy configuration feature (concepts, how-to, and references) and links them into the site navigation.
Changes:
- Added new docs pages for policy scoping, YAML schema reference, and policy API reference.
- Expanded CLI reference with
capiscio policy validateandcapiscio policy context. - Updated MkDocs navigation and enforcement concept page with policy cross-links.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Adds new Policy pages to Concepts / How-To / Reference navigation. |
| docs/reference/policy-config-yaml.md | New reference page describing the capiscio-policy.yaml schema and validation rules. |
| docs/reference/policy-api.md | New reference page documenting policy management and SDK policy-context endpoints. |
| docs/reference/cli/index.md | Documents new policy validate and policy context CLI commands and adds related links. |
| docs/how-to/configure-agent-policy.md | New how-to guide for authoring, validating, and deploying policy YAML. |
| docs/concepts/policy-scoping.md | New concept page explaining org→group→agent scoping and merge behavior. |
| docs/concepts/enforcement.md | Adds a policy-driven enforcement section and links to new policy docs. |
Comment on lines
+29
to
+36
| ### 3. Deploy to Your Organization | ||
|
|
||
| Use the dashboard UI or the CLI to create and approve a policy: | ||
|
|
||
| ```bash | ||
| # View current policy context | ||
| capiscio policy context --registry https://api.capisc.io --api-key $CAPISCIO_API_KEY | ||
| ``` |
There was a problem hiding this comment.
This section says to use “the dashboard UI or the CLI to create and approve a policy”, but the only documented capiscio policy CLI commands here are validate and context (no create/approve). Please adjust the wording to match what’s currently supported (e.g., dashboard UI and/or Policy API endpoints).
✅ Documentation Build SuccessfulThe documentation build completed successfully and passed validation checks.
|
Copilot review noted that the CLI only has validate/context commands, not create/approve. Updated wording to reference dashboard UI and Policy API instead.
✅ Documentation Build SuccessfulThe documentation build completed successfully and passed validation checks.
|
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.
POLICY-CONFIG-001 PR 8 — Policy Configuration Documentation
Summary
Adds end-user documentation for the YAML policy configuration feature, including concepts, how-to guides, and API reference.
New Pages
concepts/policy-scoping.mdhow-to/configure-agent-policy.mdreference/policy-config-yaml.mdreference/policy-api.mdUpdated Pages
reference/cli/index.mdpolicy validateandpolicy contextcommandsconcepts/enforcement.mdmkdocs.ymlRelated
internal-docs/engineering/YAML-policy-config-layer-v2.md