From 22d1001f997365e4b363a0918d90e86e8543c8ad Mon Sep 17 00:00:00 2001 From: Nathan Contino Date: Wed, 12 Aug 2026 11:59:53 -0400 Subject: [PATCH] Fix broken links in the permify docs --- docs/api-reference/bundle/write-bundle.mdx | 4 ++-- docs/getting-started/examples/facebook-groups.mdx | 2 +- docs/getting-started/examples/instagram.mdx | 2 +- docs/getting-started/examples/mercury.mdx | 2 +- docs/getting-started/examples/notion.mdx | 2 +- docs/operations/bundle.mdx | 14 +++++++------- docs/operations/tracing.mdx | 2 +- docs/permify-overview/faqs.mdx | 4 ++-- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/api-reference/bundle/write-bundle.mdx b/docs/api-reference/bundle/write-bundle.mdx index eaaf044ce..f86f41b6f 100644 --- a/docs/api-reference/bundle/write-bundle.mdx +++ b/docs/api-reference/bundle/write-bundle.mdx @@ -52,9 +52,9 @@ Let's say user:564 creates an organization:789 in your application. According to - organization:789#manager@user:564 - organization:789$public|boolean:false -Instead of using the [WriteData](./api-overview/data/write-data.md) endpoint, you can utilize [RunBundle](./api-overview/data/run-bundle.md) to create this data by simply providing specific identifiers. +Instead of using the [WriteData](../data/write-data) endpoint, you can utilize [RunBundle](../data/run-bundle) to create this data by simply providing specific identifiers. -An example request of [RunBundle](./api-overview/data/run-bundle.md) for this scenario: +An example request of [RunBundle](../data/run-bundle) for this scenario: ```json POST /bundle diff --git a/docs/getting-started/examples/facebook-groups.mdx b/docs/getting-started/examples/facebook-groups.mdx index e75b06320..ead4a8d3d 100644 --- a/docs/getting-started/examples/facebook-groups.mdx +++ b/docs/getting-started/examples/facebook-groups.mdx @@ -535,6 +535,6 @@ The validation result according to our example schema validation file: ## Need any help? -This concludes the demonstration of the authorization structure for Facebook groups. To install and implement this see the [Set Up Permify](../../installation.md) section. +This concludes the demonstration of the authorization structure for Facebook groups. To install and implement this see the [Set Up Permify](../../setting-up/installation/intro) section. If you need any kind of help, our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about it, [schedule a consultation call with one of our account executives](https://www.permify.co/book-demo). diff --git a/docs/getting-started/examples/instagram.mdx b/docs/getting-started/examples/instagram.mdx index 16fd6c90e..c71088718 100644 --- a/docs/getting-started/examples/instagram.mdx +++ b/docs/getting-started/examples/instagram.mdx @@ -325,4 +325,4 @@ The validation result according to our example schema validation file: ## Need any help? -This is the end of the demonstration of the authorization structure for Instagram. To install and implement this see the [Set Up Permify](../../installation.md) section. +This is the end of the demonstration of the authorization structure for Instagram. To install and implement this see the [Set Up Permify](../../setting-up/installation/intro) section. diff --git a/docs/getting-started/examples/mercury.mdx b/docs/getting-started/examples/mercury.mdx index 4533b6f74..4ebcb8cc6 100644 --- a/docs/getting-started/examples/mercury.mdx +++ b/docs/getting-started/examples/mercury.mdx @@ -158,4 +158,4 @@ At last, as you can see we use the Rules to define access rights to withdraw whi ## Need any help? -This is the end of the demonstration of the authorization structure for Mercury. To install and implement this see the [Set Up Permify](../../installation.md) section. +This is the end of the demonstration of the authorization structure for Mercury. To install and implement this see the [Set Up Permify](../../setting-up/installation/intro) section. diff --git a/docs/getting-started/examples/notion.mdx b/docs/getting-started/examples/notion.mdx index 4a093cb6c..73aab8075 100644 --- a/docs/getting-started/examples/notion.mdx +++ b/docs/getting-started/examples/notion.mdx @@ -538,6 +538,6 @@ The validation result according to our example schema validation file: ## Need any help? -This is the end of the demonstration of the authorization structure for Notion. To install and implement this see the [Set Up Permify](../../installation.md) section. +This is the end of the demonstration of the authorization structure for Notion. To install and implement this see the [Set Up Permify](../../setting-up/installation/intro) section. If you need any kind of help, our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about it, [schedule a consultation call with one of our account executives](https://www.permify.co/book-demo). diff --git a/docs/operations/bundle.mdx b/docs/operations/bundle.mdx index a41dd3e01..6d9673a8d 100644 --- a/docs/operations/bundle.mdx +++ b/docs/operations/bundle.mdx @@ -17,7 +17,7 @@ This functionality streamlines managing authorization data, allows you to manage Let's examine how Bundles operate. -Let's say you want to model how data will be created when an organization is created in your application. For this purpose, you can utilize the [WriteBundle](../../api-reference/bundle/write-bundle) API endpoint. This API enables users to define or update data bundles, each distinguished by a unique name. +Let's say you want to model how data will be created when an organization is created in your application. For this purpose, you can utilize the [WriteBundle](../api-reference/bundle/write-bundle) API endpoint. This API enables users to define or update data bundles, each distinguished by a unique name. Here's an example body for WriteBundle in this scenario: @@ -54,9 +54,9 @@ Let's say user:564 creates an organization:789 in your application. According to - organization:789#manager@user:564 - organization:789$public|boolean:false -Instead of using the [WriteData](../../api-reference/data/write-data) endpoint, you can utilize [RunBundle](../../api-reference/data/run-bundle) to create this data by simply providing specific identifiers. +Instead of using the [WriteData](../api-reference/data/write-data) endpoint, you can utilize [RunBundle](../api-reference/data/run-bundle) to create this data by simply providing specific identifiers. -An example request of [RunBundle](../../api-reference/data/run-bundle) for this scenario: +An example request of [RunBundle](../api-reference/data/run-bundle) for this scenario: ```json { @@ -76,7 +76,7 @@ This will result in the creation of the following data in Permify: ## Endpoints -- [WriteBundle](../../api-reference/bundle/write-bundle) -- [RunBundle](../../api-reference/data/run-bundle) -- [DeleteBundle](../../api-reference/bundle/delete-bundle) -- [ReadBundle](../../api-reference/bundle/read-bundle) +- [WriteBundle](../api-reference/bundle/write-bundle) +- [RunBundle](../api-reference/data/run-bundle) +- [DeleteBundle](../api-reference/bundle/delete-bundle) +- [ReadBundle](../api-reference/bundle/read-bundle) diff --git a/docs/operations/tracing.mdx b/docs/operations/tracing.mdx index 46224c7ac..aa0fb6f01 100644 --- a/docs/operations/tracing.mdx +++ b/docs/operations/tracing.mdx @@ -47,7 +47,7 @@ database: write: connection: 'postgres' database: 'morf-health-demo' - uri: 'postgres://postgres:SphU4Uf3QXNntT@permify.us-east-1.rds.amazonaws.com:5432' + uri: 'postgres://postgres:yourpassword@your-host.rds.amazonaws.com:5432' pool_max: 2 ``` diff --git a/docs/permify-overview/faqs.mdx b/docs/permify-overview/faqs.mdx index 4edcffbca..741de45c9 100644 --- a/docs/permify-overview/faqs.mdx +++ b/docs/permify-overview/faqs.mdx @@ -71,7 +71,7 @@ It's expected that your initial schema will eventually change as your product or As an example, when a new feature arises and related permissions are created, you need to change the schema (rewrite it with the new permission) then configure it using this Write Schema API. Afterwards, you can use the preferred version of the schema in your API requests with **schema_version**. If you do not prefer to use **schema_version** params in API calls Permify automatically gets the latest schema on API calls. -A potential caveat of changing or creating schemas too often is the creation of many idle relation tuples. In Permify, created relation tuples are not removed from the stored database unless you delete them with the [delete API](../data/delete-data.md). For this case, we have a [garbage collector](https://github.com/Permify/permify/pull/381) which you can use to clear expired or idle relation tuples. +A potential caveat of changing or creating schemas too often is the creation of many idle relation tuples. In Permify, created relation tuples are not removed from the stored database unless you delete them with the [delete API](../api-reference/data/delete-data). For this case, we have a [garbage collector](https://github.com/Permify/permify/pull/381) which you can use to clear expired or idle relation tuples. We recommend applying the following pattern to safely handle schema changes: @@ -124,7 +124,7 @@ Gathering authorization logic in a central place offers important advantages ove See the [What is Authorization Service] Section for a detailed explanation of those advantages. -[What is Authorization Service]: ../authorization-service +[What is Authorization Service]: ./authorization-service ![load-balancer](https://user-images.githubusercontent.com/34595361/201173835-6f6b67cd-d65b-4239-b695-04ecf1bad5bc.png)