Skip to content

docs: add Quick start guide for various frameworks #558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 23 commits into
base: master
Choose a base branch
from

Conversation

Pradumnasaraf
Copy link

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.

…llation steps and provide additional links to SDK documentation.
…nd improve clarity on API key and PDP URL setup across various frameworks.
…rrecting minor text inconsistencies across multiple frameworks.
…Quick Start Guides and correct minor text inconsistencies in Django, Flask, and Gin documentation.
@Copilot Copilot AI review requested due to automatic review settings May 22, 2025 06:32
Copy link

netlify bot commented May 22, 2025

Deploy Preview for permitio-docs ready!

Name Link
🔨 Latest commit 6a37f8f
🔍 Latest deploy log https://app.netlify.com/projects/permitio-docs/deploys/685be2fc17cab8000822b76c
😎 Deploy Preview https://deploy-preview-558--permitio-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@Pradumnasaraf Pradumnasaraf changed the title docs: Quick start docs: add Quick start guide for various frameworks May 22, 2025
@Pradumnasaraf
Copy link
Author

Hey, @gemanor, pinging you!

Copy link
Collaborator

@gemanor gemanor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice start for this important task! Please address the following general comments:

  1. The Overview section 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
  2. 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
    1. See the section on the difference between why and do documents, and follow that
    2. Check and adopt the general writing guidelines
  3. The template you choose (the fga-tradeoff) is hard to understand for someone who isn't familiar with Permit. Please do the following:
    1. 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)
    2. Export it to a TF file using the command permit env export terraform
    3. Open a PR in the CLI repository to contribute this to the CLI (see example PR here: )
    4. Change the examples to this template with a quick overview of the policy configured
  4. 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

…ndardizing section titles, and improving clarity on API key and PDP setup across multiple frameworks.
…creation, template usage, and API key retrieval. Add new images for better visual guidance.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants