Migrate to Mintlify - #544
Conversation
…Case - Implemented `flex.text.snakeCase` to convert strings to snake_case format. - Implemented `flex.text.swapCase` to swap the case of each character in a string. - Implemented `flex.text.upperCamelCase` to convert strings to UpperCamelCase format. - Updated UDF documentation to include usage examples and FAQs for each new function. - Added comprehensive descriptions and parameter details for better clarity.
- Deleted the main cloud index page and its associated content, including the free, startup, pro, and enterprise tier descriptions. - Removed the maintenance windows documentation for enterprise deployments. - Eliminated the monitoring dashboard guide for the Grafana monitoring dashboard. - Cleared the export and import operations documentation for RDB management. - Deleted the cloud operations index page that linked to the export/import guide. - Removed the pro tier and startup tier documentation, including pricing and features. - Updated the docs.json file to reflect the removal of cloud-related pages and groups.
|
Important Review skippedToo many files! This PR contains 265 files, which is 165 over the limit of 100. To get a review, reduce the PR to 100 files or fewer by splitting it into smaller PRs or changing its base branch. Upgrade to a paid plan to raise the limit. This review couldn't start because sufficient usage credits or metered capacity aren't available. Add credits or update usage-based reviews in the billing tab, then retry. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (265)
You can disable this status message by setting the 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 |
There was a problem hiding this comment.
Pull request overview
This pull request migrates FalkorDB’s documentation set from the legacy Jekyll/Just-the-Docs format to Mintlify MDX, updating page structure, internal linking, and reusable UI components (accordions/code groups), and adding CI checks to keep MDX and links valid.
Changes:
- Converted many docs pages from
.md(Jekyll front matter + includes) to.mdx(Mintlify front matter + components), including replacingfaq_accordion.htmlincludes with<AccordionGroup>/<Accordion>. - Normalized internal links to root-relative, extensionless paths and updated image paths to
/images/.... - Added MDX validation + broken-link checks in CI, updated spellcheck/workflows to target
.mdx, and removed Jekyll configuration artifacts.
Reviewed changes
Copilot reviewed 259 out of 261 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| udfs/flex/text/upperCamelCase.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/swapCase.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/snakeCase.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/rpad.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/replace.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/repeat.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/regexGroups.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/lpad.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/levenshtein.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/join.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/jaroWinkler.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/indexOf.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/indexesOf.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/index.mdx | New Mintlify landing page for FLEX text functions |
| udfs/flex/text/index.md | Removed legacy Jekyll landing page |
| udfs/flex/text/format.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/decapitalize.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/capitalize.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/text/camelCase.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/similarity/jaccard.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/similarity/index.mdx | New Mintlify landing page for similarity functions |
| udfs/flex/similarity/index.md | Removed legacy Jekyll landing page |
| udfs/flex/map/submap.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/map/removeKeys.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/map/removeKey.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/map/merge.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/map/index.mdx | New Mintlify landing page for map functions |
| udfs/flex/map/index.md | Removed legacy Jekyll landing page |
| udfs/flex/map/fromPairs.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/json/toJson.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/json/index.mdx | New Mintlify landing page for JSON functions |
| udfs/flex/json/index.md | Removed legacy Jekyll landing page |
| udfs/flex/json/fromJsonMap.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/json/fromJsonList.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/date/truncate.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/date/toTimeZone.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/date/parse.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/date/index.mdx | New Mintlify landing page for date functions |
| udfs/flex/date/index.md | Removed legacy Jekyll landing page |
| udfs/flex/date/format.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/collections/zip.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/collections/union.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/collections/shuffle.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/collections/intersection.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/collections/index.mdx | New Mintlify landing page for collection functions |
| udfs/flex/collections/index.md | Removed legacy Jekyll landing page |
| udfs/flex/collections/frequencies.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/bitwise/xor.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/bitwise/shiftRight.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/bitwise/shiftLeft.mdx | Mintlify front matter; escaped operator text; AccordionGroup FAQ |
| udfs/flex/bitwise/or.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/bitwise/not.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| udfs/flex/bitwise/index.mdx | New Mintlify landing page for bitwise functions |
| udfs/flex/bitwise/index.md | Removed legacy Jekyll landing page |
| udfs/flex/bitwise/and.mdx | Mintlify front matter; root-relative links; AccordionGroup FAQ |
| support.mdx | Removed Jekyll-specific navigation/permalink fields and body H1 |
| style.css | Added Mintlify sidebar spacing override CSS |
| scripts/check_mdx.mjs | New script to compile all MDX files and report syntax errors |
| operations/replication.mdx | Removed Jekyll nav/redirect fields and include-based FAQ; added AccordionGroup FAQ |
| operations/migration/redisgraph-to-falkordb.mdx | Removed Jekyll nav/redirect fields and include-based FAQ; added AccordionGroup FAQ |
| operations/migration/index.mdx | New Mintlify landing page for Migration section |
| operations/migration/index.md | Removed legacy Jekyll landing page |
| operations/lightning-ai.mdx | Removed Jekyll nav fields; fixed internal link style; AccordionGroup FAQ |
| operations/falkordblite/index.mdx | New Mintlify landing page for FalkorDBLite |
| operations/falkordblite/index.md | Removed legacy Jekyll landing page |
| operations/building-docker.mdx | Removed Jekyll fields; AccordionGroup FAQ |
| integration/index.mdx | New Mintlify landing page for Integration section |
| integration/index.md | Removed legacy Jekyll landing page |
| genai-tools/mcpserver/index.md | Removed legacy Jekyll landing page |
| genai-tools/mcpserver/docker.mdx | New Mintlify page for MCP Server Docker deployment |
| genai-tools/mcpserver/docker.md | Removed legacy Jekyll page |
| genai-tools/graphrag-server.mdx | Removed Jekyll nav fields and body H1 |
| genai-tools/graphrag-sdk.mdx | Removed Jekyll fields/redirects and body H1 |
| design/result-structure.mdx | Removed Jekyll fields/redirects; AccordionGroup FAQ |
| cypher/with.mdx | Removed Jekyll nav fields; AccordionGroup FAQ |
| cypher/where.mdx | Removed Jekyll nav fields; AccordionGroup FAQ |
| cypher/unwind.mdx | Removed Jekyll nav fields; AccordionGroup FAQ |
| cypher/union.mdx | New Mintlify page for UNION clause (replacing .md) |
| cypher/union.md | Removed legacy Jekyll page |
| cypher/skip.mdx | New Mintlify page for SKIP clause (replacing .md) |
| cypher/skip.md | Removed legacy Jekyll page |
| cypher/set.mdx | Removed Jekyll nav fields; AccordionGroup FAQ |
| cypher/return.mdx | Removed Jekyll nav fields; AccordionGroup FAQ |
| cypher/remove.mdx | New Mintlify page for REMOVE clause (replacing .md) |
| cypher/remove.md | Removed legacy Jekyll page |
| cypher/order-by.mdx | New Mintlify page for ORDER BY clause (replacing .md) |
| cypher/order-by.md | Removed legacy Jekyll page |
| cypher/optional-match.mdx | Removed Jekyll nav fields/redirects; AccordionGroup FAQ |
| cypher/merge.mdx | Removed Jekyll nav fields; AccordionGroup FAQ |
| cypher/limit.mdx | New Mintlify page for LIMIT clause (replacing .md) |
| cypher/limit.md | Removed legacy Jekyll page |
| cypher/known-limitations.mdx | Removed Jekyll nav fields/redirects; AccordionGroup FAQ |
| cypher/indexing/index.mdx | New Mintlify landing page for Indexing |
| cypher/indexing/index.md | Removed legacy Jekyll landing page |
| cypher/delete.mdx | New Mintlify page for DELETE clause (replacing .md) |
| cypher/delete.md | Removed legacy Jekyll page |
| cypher/create.mdx | Removed Jekyll nav fields; AccordionGroup FAQ |
| commands/index.mdx | New Mintlify landing page for Commands (replacing .md) |
| commands/index.md | Removed legacy Jekyll landing page |
| commands/graph.ro-query.mdx | New Mintlify page; CodeGroup examples; AccordionGroup FAQ |
| commands/graph.ro-query.md | Removed legacy Jekyll page |
| commands/graph.list.mdx | New Mintlify page; CodeGroup examples; AccordionGroup FAQ |
| commands/graph.list.md | Removed legacy Jekyll page |
| commands/graph.info.mdx | Removed Jekyll nav fields; AccordionGroup FAQ |
| cloud/operations/index.md | Removed legacy Cloud operations landing page |
| browser/ui/udf-libraries.mdx | Removed Jekyll nav fields; updated image paths; AccordionGroup FAQ |
| browser/ui/toolbar-actions.mdx | Removed Jekyll nav fields; updated image paths; AccordionGroup FAQ |
| browser/ui/table-view.mdx | New Mintlify page; updated image paths; AccordionGroup FAQ |
| browser/ui/table-view.md | Removed legacy Jekyll page |
| browser/ui/style-panel.mdx | New Mintlify page; updated image paths; AccordionGroup FAQ |
| browser/ui/style-panel.md | Removed legacy Jekyll page |
| browser/ui/settings.mdx | Removed Jekyll nav fields; updated image paths; AccordionGroup FAQ |
| browser/ui/query-history.mdx | New Mintlify page; updated image paths; AccordionGroup FAQ |
| browser/ui/query-history.md | Removed legacy Jekyll page |
| browser/ui/query-editor.mdx | New Mintlify page; updated image paths; AccordionGroup FAQ |
| browser/ui/query-editor.md | Removed legacy Jekyll page |
| browser/ui/navigation.mdx | Removed Jekyll nav fields; updated image paths; AccordionGroup FAQ |
| browser/ui/metadata-view.mdx | New Mintlify page; updated image paths; AccordionGroup FAQ |
| browser/ui/metadata-view.md | Removed legacy Jekyll page |
| browser/ui/login.mdx | Removed Jekyll nav fields; updated image paths; AccordionGroup FAQ |
| browser/ui/graph-page.mdx | Removed Jekyll nav fields; updated image paths; AccordionGroup FAQ |
| browser/ui/graph-management.mdx | New Mintlify page; links updated; AccordionGroup FAQ |
| browser/ui/graph-management.md | Removed legacy Jekyll page |
| browser/ui/graph-info-panel.mdx | New Mintlify page; updated image paths; AccordionGroup FAQ |
| browser/ui/graph-info-panel.md | Removed legacy Jekyll page |
| browser/ui/graph-canvas.mdx | Removed Jekyll nav fields; updated image paths; AccordionGroup FAQ |
| browser/ui/data-panel.mdx | Removed Jekyll nav fields; updated image paths; AccordionGroup FAQ |
| browser/ui/chat-panel.mdx | Removed Jekyll nav fields; updated image paths; AccordionGroup FAQ |
| browser/ui/auth-access-control.mdx | Removed Jekyll nav fields; updated internal link style; AccordionGroup FAQ |
| browser/ui/api-documentation.mdx | Removed Jekyll nav fields; AccordionGroup FAQ |
| browser/index.mdx | New Mintlify landing page for Browser (replacing .md) |
| browser/index.md | Removed legacy Jekyll landing page |
| browser/canvas.mdx | Removed Jekyll nav fields and body H1; formatting cleanup |
| algorithms/maxflow.mdx | Removed Jekyll nav fields and body H1 |
| algorithms/harmonic-centrality.mdx | Front matter formatting normalized; removed body H1 |
| algorithms/cdlp.mdx | Removed Jekyll nav fields; updated internal link style; AccordionGroup FAQ |
| AGENTS.md | Added repository authoring guidelines for Mintlify/MDX |
| .spellcheck.yml | Updated spellcheck sources to .mdx |
| .mintignore | Added Mintlify ignore list for non-doc content |
| .gitignore | Ignored Mintlify/Node build artifacts |
| .github/workflows/update-graph.yml | Updated workflow trigger to watch .mdx changes |
| .github/workflows/docs.yml | Added CI job for MDX compilation and Mint broken-links |
| .github/scripts/build_diff_payload.py | Updated graph ingestion payload builder to track .mdx diffs |
| _sass/color_schemes/falkordb-dark.scss | Removed legacy Jekyll theme color scheme |
| _includes/mermaid_config.js | Removed legacy Jekyll Mermaid config include |
| _includes/components/sidebar.html | Removed legacy Jekyll sidebar include |
| _config.yml | Removed legacy Jekyll site configuration |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 259 out of 261 changed files in this pull request and generated no new comments.
Suppressed comments (4)
.github/workflows/docs.yml:20
- The inline version note is misleading:
actions/setup-nodedoes not have av6.0.0release. Since the workflow is pinned by SHA, update the comment (or remove it) so it reflects reality.
uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
.github/workflows/docs.yml:17
- The inline version note is misleading:
actions/checkoutdoes not have av7.0.1release. Since the workflow is pinned by SHA, consider updating the comment to something accurate (or remove it) to avoid confusion during future maintenance.
This issue also appears on line 20 of the same file.
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
.github/workflows/docs.yml:30
- Using
mint@latestmakes CI non-deterministic (a new Mintlify CLI release can break this workflow unexpectedly). Pin to a specificmint@<version>(or installmintas a devDependency and run that version) for reproducible checks.
run: npx --yes mint@latest broken-links
cypher/limit.mdx:9
- This fenced block is Cypher syntax, but it's marked as
sql, which can produce misleading syntax highlighting and linting. Usecypher(ortext) instead.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 259 out of 261 changed files in this pull request and generated no new comments.
Suppressed comments (2)
udfs/flex/bitwise/shiftLeft.mdx:39
- The rendered text currently includes escaped shift operator
\<\<. In MDX this is easy to misrender (or show the backslashes) and is less readable than using an inline code span, which also safely contains the<characters.
cypher/union.mdx:33 - The prose currently uses a backslash-escaped
\{\}sequence (CALL \{\}), which can render with literal backslashes depending on the MDX/Markdown renderer. Wrapping it in an inline code span avoids MDX brace parsing issues and ensures the docs show the intendedCALL {}syntax.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 259 out of 261 changed files in this pull request and generated no new comments.
Suppressed comments (3)
commands/graph.ro-query.mdx:10
- Same as above: “read-only” should be hyphenated here as well.
commands/graph.ro-query.mdx:6 - Use hyphenation for the compound adjective “read-only” (Mintlify pages consistently use hyphenated forms like this, and it reads better in headings/front matter).
AGENTS.md:16 - Since Cloud/Enterprise docs are now external (linked via
navigation.products), redirects that map/cloud/...to local destinations will likely produce 404s because this repo no longer containscloud/**pages. Consider updating/removing those redirects (e.g., point them at the external Cloud docs domain) so legacy links don’t break.
FalkorDB documentation is split across three repositories, surfaced to readers
as three products in one site (see `navigation.products` in `docs.json`):
| Product | Repository |
| --- | --- |
| FalkorDB (this repo) | `FalkorDB/docs` |
| FalkorDB Cloud | `FalkorDB/falkordb-cloud-docs` |
| FalkorDB Enterprise | `FalkorDB/FalkorDB-Enterprise` (`docs/`) |
Only edit FalkorDB core content here. Cloud and Enterprise pages live in their
own repositories and are linked from the product switcher.
… update links in index
…d add aggregation script
fix #543