Skip to content

docs(databases): hidden pages for the Databases early access - #7382

Draft
chitalian wants to merge 4 commits into
mainfrom
justin/databases-docs
Draft

chitalian wants to merge 4 commits into
mainfrom
justin/databases-docs

Conversation

@chitalian

@chitalian chitalian commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

What

Hidden documentation for Mintlify Databases. Nothing is added to docs.json, so every page builds but stays out of navigation and is reachable by URL only.

Guides under databases/:

  • /databases/overview, /databases/quickstart, /databases/columns, /databases/api (overview + errors), /databases/live-updates, /databases/component

API reference under api/databases/, generated from the new databases-openapi.json like the static-export spec, so each page gets parameter tables, schemas and the playground:

  • list-databases, create-database, get-database, delete-database
  • get-schema, add-columns, update-column, delete-column
  • list-rows, upsert-rows, create-row, get-row, update-row, delete-row
  • get-changes

What is real vs. planned

  • Real (behind the DATABASES entitlement once mintlify/server#8220, mintlify/server#8221 and mintlify/mint#11275 land): everything in the API reference and the live-updates page. The examples were run against the worker locally.
  • Planned: the <Database /> component, row-page templates, and the mint.db snippet helper. That page carries an <Info> saying so; prop names follow the product spec and may change.

Style

Follows .cursor/rules/writing-standards.mdc: second person, active voice, property descriptions end with periods, limits and errors in tables.

🤖 Generated with Claude Code

Overview, quickstart, column types, REST API, live updates and the
Database component. Not added to docs.json on purpose; the pages are
reachable by URL only while the feature is in early access.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
mintlify 🟢 Ready View Preview Sep 16, 2026, 7:49 AM

databases-openapi.json describes the fifteen endpoints; each page under
api/databases carries an openapi frontmatter so the reference renders
parameters, schemas and the playground like the rest of the API
section. databases/api.mdx becomes the overview that links to them.
Still absent from docs.json.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant