Initial CLI docs #566
Open
Initial CLI docs #566
Conversation
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
✅ Deploy Preview for permitio-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
Adds the initial Permit CLI quickstart documentation and updates sidebar ordering and metadata across overview guides.
- Introduces a new
permit-cli-quickstartdoc and links it in the sidebar - Bumps
sidebar_position, titles, descriptions, and progress indicators for existing overview pages - Adds a reference entry for the CLI under the SDK sidebar
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| sidebars.js | Insert CLI quickstart into overview and CLI reference under SDK |
| docs/overview/sync-your-first-user-with-sdk.mdx | Incremented sidebar position |
| docs/overview/sync-applications-data.mdx | Updated sidebar position, title, description, and WhatsNext progress |
| docs/overview/setup-attribute-based-access-control.mdx | Updated sidebar position, title, description, and WhatsNext progress |
| docs/overview/permit-cli-quickstart.mdx | Added new quickstart guide for Permit CLI |
| docs/overview/perform-policy-check-with-cloud-pdp.mdx | Incremented sidebar position and added CLI link in WhatsNext |
| docs/overview/local-authorization-microservice.mdx | Updated sidebar position, title, description, and WhatsNext progress |
| docs/overview/create-a-rebac-policy.mdx | Updated sidebar position, added description, and WhatsNext progress |
| docs/overview/advanced-authorization-queries.mdx | Updated sidebar position, added description, and WhatsNext progress |
| docs/overview/access-requests-and-approvals.mdx | Updated sidebar position, title, and description |
Comments suppressed due to low confidence (1)
docs/overview/permit-cli-quickstart.mdx:230
- This checklist item mentions audit replay and end-to-end tests, but the walkthrough never covers those steps; either remove it or add the corresponding instructions.
- ✅ Tested your policies with audit replay and end-to-end tests
| @@ -141,7 +142,7 @@ resources—if the conditions (like their role, location, and task type) align p | |||
| policy. This adaptability makes ABAC a popular choice for modern, cloud-based systems | |||
| ::: | |||
|
|
|||
| <WhatsNext progress={60} customText="You are now a master of ABAC!"> | |||
| <WhatsNext progress={70} customText="You are now a master of ABAC!"> | |||
There was a problem hiding this comment.
[nitpick] Progress percentages are updated manually across multiple docs and can easily drift; consider deriving this value dynamically or centralizing it to reduce maintenance overhead.
Suggested change
| <WhatsNext progress={70} customText="You are now a master of ABAC!"> | |
| const totalSteps = 5; // Total number of steps in the guide | |
| const completedSteps = 5; // Number of steps completed so far | |
| const progress = Math.round((completedSteps / totalSteps) * 100); | |
| <WhatsNext progress={progress} customText="You are now a master of ABAC!"> |
Copilot uses AI. Check for mistakes.
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
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.
No description provided.