8000 docs: add Quick start guide for various frameworks #558
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
This PR adds comprehensive quick start guides for integrating Permit.io into various frameworks and languages. The changes include updates to the sidebar navigation and new MDX documentation files covering Spring Boot, Rails, Next.js, NestJS, Gin, Flask, FastAPI, Express.js, Django, and ASP.NET, along with a category configuration file.
Reviewed Changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.js | Adds a new "Quick Start Guide" category to the sidebar. |
| docs/quick-start/spring-boot.mdx | Introduces a guide for integrating Permit.io with Spring Boot. |
| docs/quick-start/rails.mdx | Introduces a guide for integrating Permit.io with Rails. |
| docs/quick-start/nextjs.mdx | Introduces a guide for integrating Permit.io with Next.js. |
| docs/quick-start/nest.mdx | Introduces a guide for integrating Permit.io with NestJS. |
| docs/quick-start/gin.mdx | Introduces a guide for integrating Permit.io with a Gin (Go) app. |
| docs/quick-start/flask.mdx | Introduces a guide for integrating Permit.io with Flask. |
| docs/quick-start/fastapi.mdx | Introduces a guide for integrating Permit.io with FastAPI. |
| docs/quick-start/express.mdx | Introduces a guide for integrating Permit.io with Express.js. |
| docs/quick-start/django.mdx | Introduces a guide for integrating Permit.io with Django. |
| docs/quick-start/aspnet.mdx | Introduces a guide for integrating Permit.io with ASP.NET. |
| docs/quick-start/category.json | Configures the sidebar category for quick start guides. |
|
Hey, @gemanor, pinging you! |
gemanor
requested changes
Jun 8, 2025
There was a problem hiding this comment.
Nice start for this important task! Please address the following general comments:
- The
Overviewsection isn't in line with the documentation style. Please look at other pages (the walkthroughs are great example). We should have 2 paragraphs in large text that give a quick overview. All your documents start with an H1 title that cancels this large font introduction - The writing style, mainly in the introduction and a little in the documents themselves, doesn't fit our guidelines. Please find more here: https://github.com/permitio/docs/blob/master/CONTRIBUTING.md
- See the section on the difference between
whyanddodocuments, and follow that - Check and adopt the general writing guidelines
- See the section on the difference between
- The template you choose (the fga-tradeoff) is hard to understand for someone who isn't familiar with Permit. Please do the following:
- In a clean environment, create a simple policy that is easy to understand for a common use case (for example, RBAC/ReBAC blogging platform policy)
- Export it to a TF file using the command
permit env export terraform - Open a PR in the CLI repository to contribute this to the CLI (see example PR here: )
- Change the examples to this template with a quick overview of the policy configured
- The long sections of the timeline components make it really hard to follow. Again, see the example of the utilization of the timeline components in the walkthrough guides, and follow this styling
8f19fde to
bcfb43b
Compare
…nt access control using Permit.io. Enhanced content clarity, added detailed steps for user registration, role assignment, and policy enforcement. Updated images for user permission checks.
…fy user registration process. Updated section titles from "Registering a new user" to "Testing the registration process" and refined descriptions for the `/register` endpoint. Enhanced instructions for using `curl` to demonstrate registration.
426684c to
df6632f
Compare
…forcement instructions for user access checks
…tions and add new image for role assignment
9235c44 to
22f68f5
Compare
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.
Changes
Added quick start guides for Django, Flask, Next.js, NestJS, Express.js, Gin, Spring Boot, ASP.NET, and Ruby on Rails. Each follows the new structure: Permit CLI setup, SDK integration, user/tenant sync, role assignment, local PDP with Docker, and policy enforcement.