Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
18 changes: 9 additions & 9 deletions .github/workflows/broken-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,31 @@ name: Check Broken Links in MDX Files
on:
pull_request:
paths:
- 'mintlify/**/*.mdx'
- 'docs/**/*.mdx'
- '.github/workflows/broken-links.yml'
- 'mintlify/check-links.sh'
- 'docs/check-links.sh'

permissions:
contents: read

jobs:
check-broken-links:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Install Mintlify CLI
run: npm install -g mintlify

- name: Run broken links check
run: |
echo "## 🔍 Checking for broken links (excluding /api-reference)..."
echo ""

# Run the check script
./mintlify/check-links.sh
./docs/check-links.sh

echo ""
echo "> **Note**: Links to \`/api-reference/\` are automatically excluded from this check."
echo "> **Note**: Links to \`/api-reference/\` are automatically excluded from this check."
9 changes: 7 additions & 2 deletions mintlify/CLAUDE.md → docs/CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
This is a Mintlify documentation site for Bytebase, a database DevOps and CI/CD platform. The repository contains:

- **Content Structure**: Documentation is organized into MDX files following a hierarchical structure with main sections for:

- Introduction & Getting Started
- Features (Database CI/CD, SQL Editor, Permissions, Data Masking)
- Administration & Security
Expand All @@ -21,6 +22,7 @@ This is a Mintlify documentation site for Bytebase, a database DevOps and CI/CD
## Development Commands

### Local Development

```bash
# Start development server (requires Mintlify CLI)
mint dev
Expand All @@ -30,14 +32,17 @@ mint install
```

### Prerequisites

- Install Mintlify CLI globally: `npm i -g mint`
- Run commands from the root directory where `docs.json` is located

### Testing

```bash
# Check for broken links (excluding /api-reference)
./mintlify/check-links.sh
./docs/check-links.sh
```

Run this test before committing any documentation changes to ensure all internal links are valid.

## Content Management
Expand All @@ -58,4 +63,4 @@ Run this test before committing any documentation changes to ensure all internal
- Uses Mintlify's "mint" theme with custom purple branding (#4F46E5)
- Lucide icon library for consistent iconography
- Plausible analytics integration for docs.bytebase.com
- Contextual options enabled for copy, view, ChatGPT, and Claude integration
- Contextual options enabled for copy, view, ChatGPT, and Claude integration
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading