docs: update mintlify site for fusionauth docs proxy#2901
docs: update mintlify site for fusionauth docs proxy#2901omer-topal merged 12 commits intoPermify:masterfrom
Conversation
This reverts commit 0a42810.
📝 WalkthroughWalkthroughThis PR updates the documentation site structure and styling for FusionAuth integration, converting absolute external links to relative internal routes, removing acquisition notices, adding comprehensive CSS theming, and updating site configuration including branding, colors, fonts, and navigation elements. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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 |
omer-topal
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/getting-started/end-to-end-example.mdx (1)
463-469:⚠️ Potential issue | 🟡 MinorReplace the leftover localhost docs link in this section.
While this block is being migrated to internal docs routes, Line 465 still points readers to
http://localhost:3000/getting-started/sync-data. That will be a dead link in every published environment, so this section should use the same internal pathing as the other rewritten docs links.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/getting-started/end-to-end-example.mdx` around lines 463 - 469, Replace the hardcoded localhost link currently shown as "http://localhost:3000/getting-started/sync-data" (the target of the "[Storing Data]" link) with the internal/docs route used elsewhere in the docs (i.e., the same relative/internal path pattern used for other rewritten links) so the link resolves in published environments; update the link target where the "[Storing Data]" anchor appears in the "Relationships" block to use the internal path instead of the localhost URL.
🤖 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/custom.css`:
- Around line 95-98: The CSS rule hiding the docs search is removing the primary
search affordance; locate the selector `#navbar` [id="search-bar-entry"] in
custom.css and remove or disable the rule (delete the block or change it so it
does not set display:none !important), ensuring the search entry remains visible
(e.g., allow default display or set display:block) and remove the !important
override so other styles can control visibility.
- Around line 1-8: The stylesheet fails stylelint due to import-notation and
font-family-name-quotes issues: replace the `@import` url(...) with a string-style
import (e.g. `@import` "https://fonts.googleapis.com/..." ) and normalize
font-family quoting by using double quotes for multi-word font names and
removing quotes from generic family names; update the selectors shown (*,
*::before, *::after and pre, code, kbd, samp, tt) so entries like "Inter",
"JetBrains Mono", "Fira Code" use double quotes and monospace/sans-serif are
unquoted to satisfy the font-family-name-quotes rule.
---
Outside diff comments:
In `@docs/getting-started/end-to-end-example.mdx`:
- Around line 463-469: Replace the hardcoded localhost link currently shown as
"http://localhost:3000/getting-started/sync-data" (the target of the "[Storing
Data]" link) with the internal/docs route used elsewhere in the docs (i.e., the
same relative/internal path pattern used for other rewritten links) so the link
resolves in published environments; update the link target where the "[Storing
Data]" anchor appears in the "Relationships" block to use the internal path
instead of the localhost URL.
🪄 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: 0ddba5c8-319d-4e66-b5c2-682bef3ef19d
⛔ Files ignored due to path filters (3)
docs/favicon.pngis excluded by!**/*.pngdocs/logo/dark.svgis excluded by!**/*.svgdocs/logo/light.svgis excluded by!**/*.svg
📒 Files selected for processing (10)
docs/api-reference/introduction.mdxdocs/cloud/intro.mdxdocs/custom.cssdocs/docs/permify-overview/authorization-service.mddocs/docs/permify-overview/intro.mddocs/getting-started/end-to-end-example.mdxdocs/getting-started/enforcement.mdxdocs/mint.jsondocs/modeling-guides/abac/public-private.mdxdocs/permify-overview/intro.mdx
💤 Files with no reviewable changes (2)
- docs/permify-overview/intro.mdx
- docs/docs/permify-overview/intro.md
| @import url('https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap'); | ||
|
|
||
| *, *::before, *::after { | ||
| font-family: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', system-ui, sans-serif !important; | ||
| } | ||
|
|
||
| pre, code, kbd, samp, tt { | ||
| font-family: 'JetBrains Mono', 'Fira Code', 'Menlo', 'Monaco', 'Consolas', monospace !important; |
There was a problem hiding this comment.
Fix the stylelint violations before landing this stylesheet.
These lines already trip the configured CSS rules: import-notation on Line 1 and font-family-name-quotes on Lines 4 and 8. This will keep the new stylesheet from passing lint as-is.
Suggested lint-safe cleanup
-@import url('https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap');
+@import 'https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap';
*, *::before, *::after {
- font-family: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', system-ui, sans-serif !important;
+ font-family: Inter, -apple-system, BlinkMacSystemFont, 'Segoe UI', system-ui, sans-serif !important;
}
pre, code, kbd, samp, tt {
- font-family: 'JetBrains Mono', 'Fira Code', 'Menlo', 'Monaco', 'Consolas', monospace !important;
+ font-family: 'JetBrains Mono', 'Fira Code', Menlo, Monaco, Consolas, monospace !important;
}📝 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.
| @import url('https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap'); | |
| *, *::before, *::after { | |
| font-family: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', system-ui, sans-serif !important; | |
| } | |
| pre, code, kbd, samp, tt { | |
| font-family: 'JetBrains Mono', 'Fira Code', 'Menlo', 'Monaco', 'Consolas', monospace !important; | |
| `@import` 'https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap'; | |
| *, *::before, *::after { | |
| font-family: Inter, -apple-system, BlinkMacSystemFont, 'Segoe UI', system-ui, sans-serif !important; | |
| } | |
| pre, code, kbd, samp, tt { | |
| font-family: 'JetBrains Mono', 'Fira Code', Menlo, Monaco, Consolas, monospace !important; | |
| } |
🧰 Tools
🪛 Stylelint (17.7.0)
[error] 4-4: Expected no quotes around "Inter" (font-family-name-quotes)
(font-family-name-quotes)
[error] 8-8: Expected no quotes around "Menlo" (font-family-name-quotes)
(font-family-name-quotes)
[error] 8-8: Expected no quotes around "Monaco" (font-family-name-quotes)
(font-family-name-quotes)
[error] 8-8: Expected no quotes around "Consolas" (font-family-name-quotes)
(font-family-name-quotes)
[error] 1-1: Expected "url('https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap')" to be "'https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap'" (import-notation)
(import-notation)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/custom.css` around lines 1 - 8, The stylesheet fails stylelint due to
import-notation and font-family-name-quotes issues: replace the `@import` url(...)
with a string-style import (e.g. `@import` "https://fonts.googleapis.com/..." )
and normalize font-family quoting by using double quotes for multi-word font
names and removing quotes from generic family names; update the selectors shown
(*, *::before, *::after and pre, code, kbd, samp, tt) so entries like "Inter",
"JetBrains Mono", "Fira Code" use double quotes and monospace/sans-serif are
unquoted to satisfy the font-family-name-quotes rule.
| /* Search bar — hidden */ | ||
| #navbar [id="search-bar-entry"] { | ||
| display: none !important; | ||
| } |
There was a problem hiding this comment.
Keep the docs search entry visible.
This removes the primary search affordance from the navbar. On a docs site this is a high-friction navigation regression, especially for first-time users and keyboard/mouse users who rely on the visible entry point rather than hidden shortcuts.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/custom.css` around lines 95 - 98, The CSS rule hiding the docs search is
removing the primary search affordance; locate the selector `#navbar`
[id="search-bar-entry"] in custom.css and remove or disable the rule (delete the
block or change it so it does not set display:none !important), ensuring the
search entry remains visible (e.g., allow default display or set display:block)
and remove the !important override so other styles can control visibility.
1 participant
Summary by CodeRabbit
Release Notes
Documentation
Chores