feat(fga): POC — Docusaurus to Mintlify migration as fga/ microsite#1423
Open
nick-gagliardi wants to merge 1 commit into
Open
feat(fga): POC — Docusaurus to Mintlify migration as fga/ microsite#1423nick-gagliardi wants to merge 1 commit into
nick-gagliardi wants to merge 1 commit into
Conversation
10 representative pages converted from atko-cic/fga-docs covering every Docusaurus-ism (admonitions, Tabs/TabItem, SVG-as-component imports, asset paths, branding helpers). - fga/docs.json modeled on auth4genai/docs.json, targeting docs.fga.dev - Two ported viewer components (CheckRequestViewer, AuthzModelSnippetViewer) in fga/snippets/; remaining seven viewers stubbed as <Tip> placeholders - Two reusable conversion scripts: convert.mjs (regex-based five-pass) and cleanup.mjs (idempotent post-process) - MIGRATION_NOTES.md documenting patterns, limitations, and the path to converting the remaining 78 pages mint broken-links passes with 0 parse errors.
Contributor
Summary
Errors per inputErrors in fga/getting-started/new-getting-started.mdx
Redirects per inputRedirects in fga/getting-started/new-getting-started.mdx
Redirects in fga/interacting/managing-user-access.mdx
Redirects in fga/intro/about-auth0-fga.mdx
Redirects in fga/intro/authorization-concepts.mdx
Redirects in fga/intro/fga-concepts.mdx
Redirects in fga/migration-instructions.mdx
Redirects in fga/modeling/direct-access.mdx
Redirects in fga/modeling/getting-started.mdx
Redirects in fga/modeling/user-groups.mdx
|
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
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.
Summary
POC for migrating the FGA docs from Docusaurus (
atko-cic/fga-docs) to Mintlify, landing as a new self-containedfga/microsite alongsidemain/andauth4genai/. Final URL target:docs.fga.dev.10 representative pages were converted, chosen to exercise every Docusaurus-ism we'll hit when migrating the remaining 78 pages.
What's in the POC
fga/docs.json— Mintlify config modeled onauth4genai/docs.json, Auth0 orange palette, 5 redirects ported fromdocusaurus.config.jsfga/snippets/:CheckRequestViewer.jsx— fully ported, generates SDK code for 9 languages from propsAuthzModelSnippetViewer.jsx— JSON-only port (DSL pending — see notes)SupportedLanguage.jsx— shared constantsfga/scripts/convert.mjs— five-pass regex converter (imports, admonitions, tabs, frontmatter, branding helpers)fga/scripts/cleanup.mjs— idempotent post-process (Tip placeholders for unported viewers, HTML comment stripping, viewer import injection)fga/MIGRATION_NOTES.md— patterns documented for the team to apply to the remaining 78 pagesConversion patterns validated
:::note/info/tip/caution/warning/danger<Note>/<Info>/<Tip>/<Warning><Tabs groupId>+<TabItem value label><Tabs>+<Tab title><ProductName format={...}/><ProductConcept section linkName/>/intro/fga-concepts#section<UpdateProductNameInLinks link name/>sidebar_position,slug)permalink)@site/static/img/foo.svgSVG-as-component<img src="/img/foo.svg">./assets/foo.pngand variants/img/foo.png<RelatedSection relatedLinks={[...]}/><CardGroup>of<Card>fga/snippets/*.jsxKnown limitations
AuthzModelSnippetViewerrenders JSON, not DSL. The original uses@openfga/syntax-transformerfor JSON→DSL conversion; bundling that into Mintlify's snippet runtime is a follow-up. Pages that passsyntaxesToShow={[SyntaxFormat.Dsl]}show JSON with a note. The component accepts an optionaldslprop for pre-computed DSL strings.<Tip>placeholders:BatchCheckRequestViewer,WriteRequestViewer,ListObjectsRequestViewer,ListUsersRequestViewer,ReadChangesRequestViewer,ExpandRequestViewer,RelationshipTuplesViewer. Porting pattern documented inMIGRATION_NOTES.md../configuration-language,./parent-child.mdx). They resolve once those pages migrate.Test plan
cd fga && mint dev— disable VPN on first run perdocs-v2/CLAUDE.mddocs.json(5 groups)<Tabs>switching ongetting-started/perform-checkandmigration-instructions<Note>,<Info>,<Tip>,<Warning>)getting-started/new-getting-startedand inline SVGs render onmodeling/getting-started<CheckRequestViewer>shows tabs for all 9 languages with correct generated code ongetting-started/perform-check<AuthzModelSnippetViewer>renders JSON onmodeling/direct-access(and shows the JSON-fallback message for DSL views)mint broken-links— already validated locally (0 parse errors, 71 broken links to non-POC pages)Open items (not blocking POC)
auth4genai/mcp/get-started/secure-mcp-server-with-auth0-fga.mdxstays put; cross-link from there to this microsite once livedocs.fga.devDNS setup is out of scope