chore: add php sdk link to docs#2910
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
💤 Files with no reviewable changes (1)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdded a PHP SDK link to the API reference introduction, introduced a new Mintlify docs configuration ( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs.json`:
- Around line 12-14: The "tabs" array contains a tab object with the label "FGA
Documentation" which is likely a copy-paste error; update the "tab" value in
that object from "FGA Documentation" to the correct project label (e.g.,
"Documentation" or "Permify") and make the same change for the other occurrence
of the same tab label later in the file so both tab entries match the project
naming.
- Line 4: The site metadata key "name" in docs.json is a stale copy-paste value
("FGA Documentation"); update the "name" property to the correct project/site
title (e.g., "Permify") so the browser title/header reflects the repository,
ensuring you edit the "name" field in docs.json rather than other keys.
- Around line 231-238: The navbar entry currently under "navbar" -> "links" with
label "FusionAuth Documentation" and href "/docs/" is incorrect; either replace
that entry's label and href with an intentional Permify target (for example set
label to "Permify Docs" and href to the main site or GitHub URL) or remove the
object entirely; update the JSON object that contains "label": "FusionAuth
Documentation" and "href": "/docs/" accordingly so it points to the correct
destination or is omitted.
- Around line 370-377: Update the redirect entry whose "source" is
"/use-cases/use-cases/simple-rbac" so its "destination" is the final path
"/use-cases/rbac" (remove the duplicated "/use-cases/use-cases/" prefix); leave
the more general rule for "/use-cases/use-cases/:slug*" -> "/use-cases/:slug*"
as-is if you still need it, but ensure this specific mapping points directly to
"/use-cases/rbac".
- Around line 302-305: The redirect entry mapping "source":
"/installation/installation/azure" to "destination":
"/setting-up/installation/azure" points to a non-existent target; either add the
migrated azure page at docs/setting-up/installation/ (create azure.mdx and
include it in the Deployment section) or remove this redirect from docs.json.
Locate the redirect object in docs.json (the mapping with source
"/installation/installation/azure") and either (A) add the new page file under
setting-up/installation/ and add its path to the Deployment pages list in
docs.json, or (B) delete this redirect object so there is no dangling link.
In `@docs/package.json`:
- Around line 9-11: Update the mintlify dependency entry that currently reads
"mintlify": "^4.2.466" to the latest published version "mintlify": "^4.2.521";
after updating the dependency string for mintlify, run your package manager to
refresh the lockfile (npm install or yarn install) so package-lock.json /
yarn.lock reflects the new version and ensure docs build succeeds.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 96a2cf33-c059-4af3-86b2-462ba40fac4b
⛔ Files ignored due to path filters (1)
docs/package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (3)
docs/api-reference/introduction.mdxdocs/docs.jsondocs/package.json
| { | ||
| "$schema": "https://mintlify.com/docs.json", | ||
| "theme": "mint", | ||
| "name": "FGA Documentation", |
There was a problem hiding this comment.
Site name says "FGA Documentation" — looks like a copy-paste leftover.
This is the Permify repository, but the site name is set to "FGA Documentation" (matching the stale docs/mint.json used as a template). This will render in the browser title/header. Should this be "Permify" (or similar)?
Proposed fix
- "name": "FGA Documentation",
+ "name": "Permify",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "name": "FGA Documentation", | |
| "name": "Permify", |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs.json` at line 4, The site metadata key "name" in docs.json is a
stale copy-paste value ("FGA Documentation"); update the "name" property to the
correct project/site title (e.g., "Permify") so the browser title/header
reflects the repository, ensuring you edit the "name" field in docs.json rather
than other keys.
| "tabs": [ | ||
| { | ||
| "tab": "FGA Documentation", |
There was a problem hiding this comment.
Tab label "FGA Documentation" likely incorrect.
Same copy-paste concern as the site name: the first tab is labeled "FGA Documentation". Consider renaming it to something like "Documentation" or "Permify" to match this project.
Also applies to: 150-151
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs.json` around lines 12 - 14, The "tabs" array contains a tab object
with the label "FGA Documentation" which is likely a copy-paste error; update
the "tab" value in that object from "FGA Documentation" to the correct project
label (e.g., "Documentation" or "Permify") and make the same change for the
other occurrence of the same tab label later in the file so both tab entries
match the project naming.
| "navbar": { | ||
| "links": [ | ||
| { | ||
| "label": "FusionAuth Documentation", | ||
| "href": "/docs/" | ||
| } | ||
| ] | ||
| }, |
There was a problem hiding this comment.
Navbar link points to "FusionAuth Documentation" — wrong product/URL.
The navbar exposes a link labeled "FusionAuth Documentation" with href: "/docs/". That label is from an unrelated product, and /docs/ is also being redirected away (/docs/:slug* → /:slug* at Line 263‑264), so this link will strip itself and resolve to the site root. Please update the label and destination to an intentional Permify target (e.g., the main site or GitHub), or remove the entry.
Example fix
"navbar": {
"links": [
{
- "label": "FusionAuth Documentation",
- "href": "/docs/"
+ "label": "Permify",
+ "href": "https://permify.co"
}
]
},📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "navbar": { | |
| "links": [ | |
| { | |
| "label": "FusionAuth Documentation", | |
| "href": "/docs/" | |
| } | |
| ] | |
| }, | |
| "navbar": { | |
| "links": [ | |
| { | |
| "label": "Permify", | |
| "href": "https://permify.co" | |
| } | |
| ] | |
| }, |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs.json` around lines 231 - 238, The navbar entry currently under
"navbar" -> "links" with label "FusionAuth Documentation" and href "/docs/" is
incorrect; either replace that entry's label and href with an intentional
Permify target (for example set label to "Permify Docs" and href to the main
site or GitHub URL) or remove the object entirely; update the JSON object that
contains "label": "FusionAuth Documentation" and "href": "/docs/" accordingly so
it points to the correct destination or is omitted.
| { | ||
| "source": "/use-cases/use-cases/simple-rbac", | ||
| "destination": "/use-cases/use-cases/rbac" | ||
| }, | ||
| { | ||
| "source": "/use-cases/use-cases/:slug*", | ||
| "destination": "/use-cases/:slug*" | ||
| }, |
There was a problem hiding this comment.
Redirect destination still contains the duplicated /use-cases/use-cases/ prefix.
/use-cases/use-cases/simple-rbac → /use-cases/use-cases/rbac relies on the following rule (Line 374‑377) to chain-rewrite into /use-cases/rbac. Many redirect engines don't re-evaluate redirects, and even when they do, chained 3xx hops hurt SEO and UX. Point this directly at the final destination.
Proposed fix
{
"source": "/use-cases/use-cases/simple-rbac",
- "destination": "/use-cases/use-cases/rbac"
+ "destination": "/use-cases/rbac"
},📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| { | |
| "source": "/use-cases/use-cases/simple-rbac", | |
| "destination": "/use-cases/use-cases/rbac" | |
| }, | |
| { | |
| "source": "/use-cases/use-cases/:slug*", | |
| "destination": "/use-cases/:slug*" | |
| }, | |
| { | |
| "source": "/use-cases/use-cases/simple-rbac", | |
| "destination": "/use-cases/rbac" | |
| }, | |
| { | |
| "source": "/use-cases/use-cases/:slug*", | |
| "destination": "/use-cases/:slug*" | |
| }, |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs.json` around lines 370 - 377, Update the redirect entry whose
"source" is "/use-cases/use-cases/simple-rbac" so its "destination" is the final
path "/use-cases/rbac" (remove the duplicated "/use-cases/use-cases/" prefix);
leave the more general rule for "/use-cases/use-cases/:slug*" ->
"/use-cases/:slug*" as-is if you still need it, but ensure this specific mapping
points directly to "/use-cases/rbac".
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2910 +/- ##
==========================================
- Coverage 82.58% 81.98% -0.60%
==========================================
Files 74 74
Lines 8300 11215 +2915
==========================================
+ Hits 6854 9193 +2339
- Misses 910 1486 +576
Partials 536 536 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1 participant
Summary by CodeRabbit
Documentation
Chores