Spring AI Community Documentation

Mintlify-powered documentation for the Spring AI Community.

Quick Start

Local Preview (REQUIRED before commits)

# Start development server
./dev-preview.sh

# Or specify a port
./dev-preview.sh 3001

# Or use mintlify directly
mintlify dev

View at: http://localhost:3000

Pre-commit Validation

Always run before committing:

./pre-commit-check.sh

This checks for:

• Broken links
• Invalid JSON syntax in mint.json
• Git status

Development Workflow

1. Make Changes

Edit .mdx files or mint.json

2. Preview Locally

./dev-preview.sh

3. Validate

./pre-commit-check.sh

4. Commit (if checks pass)

git add <files>
git commit -m "Description"

5. Final Review

git show HEAD

6. Push

git push origin main

Project Structure

mintlify-docs/
├── mint.json              # Navigation and config
├── index.mdx             # Homepage
├── community/            # Community docs
│   ├── index.mdx
│   ├── governance.mdx
│   └── ...
├── projects/             # Project showcase
│   ├── production/
│   └── incubating/
├── benchmarking/         # Spring AI Bench info
└── get-involved/         # Contribution guide

Key Differences from AsciiDoc

AsciiDoc	Mintlify
.adoc files	.mdx files
asciidoctor to build	No build step
asciidoctor --watch	mintlify dev
Attributes (:toc:)	Components (<Card>)
include::file.adoc[]	<Snippet file="snippet.mdx" />
Config in files	Config in mint.json

Important Commands

# Start dev server
mintlify dev

# Check for broken links
mintlify broken-links

# Rename file and update references
mintlify rename old-file.mdx new-file.mdx

# Validate OpenAPI spec
mintlify openapi-check api-reference/openapi.json

Common Components

Cards

<Card title="Title" icon="icon-name" href="/path">
  Content
</Card>

Card Groups

<CardGroup cols={2}>
  <Card>...</Card>
  <Card>...</Card>
</CardGroup>

Steps

<Steps>
  <Step title="First">Content</Step>
  <Step title="Second">Content</Step>
</Steps>

Accordions

<AccordionGroup>
  <Accordion title="Question">Answer</Accordion>
</AccordionGroup>

Tabs

<Tabs>
  <Tab title="Option 1">Content</Tab>
  <Tab title="Option 2">Content</Tab>
</Tabs>

Callouts

<Note>Important information</Note>
<Warning>Warning message</Warning>
<Info>Info message</Info>
<Check>Success message</Check>

Validation

• Run ./pre-commit-check.sh before every commit
• The script checks for broken links and syntax errors
• Review changes with git diff before committing

Resources

• Mintlify Documentation
• Spring AI Community
• MDX Documentation