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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .cursor/rules/docs-icons.mdc
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
description: Enforce sidebar icons on all documentation pages and categories
globs: docs/**/*.md, docs/**/_category_.json
alwaysApply: false
---

# Sidebar Icon Requirement

Every doc page and category MUST have a sidebar icon from `lucide-react`.

## Markdown pages (`docs/**/*.md`)

Add `sidebar_custom_props` with an `icon` in frontmatter:

```yaml
---
sidebar_position: 1
sidebar_custom_props:
icon: Rocket
---
```

## Category folders (`_category_.json`)

Add `customProps` with an `icon`:

```json
{
"label": "Features",
"position": 3,
"customProps": {
"icon": "Sparkles"
}
}
```

## Available icons

Only use icons registered in `src/utils/sidebarIcons.js`:

BookOpen, Network, BrainCircuit, Rocket, Layers, Sparkles, LibraryBig, Wrench, Bot, ShieldCheck, Lock, KeyRound, Link, Globe, Plug, Route, Coins, Target, Gauge, MessageSquareText, FlaskConical, Fingerprint, Activity, ClipboardList, Handshake

## Adding a new icon

If none of the above fit:

1. Import the icon from `lucide-react` in `src/utils/sidebarIcons.js`
2. Add it to `iconMap`
3. Use the exact export name as the icon value

Browse https://lucide.dev/icons to find appropriate icons.

## Rules

- NEVER create a doc page or category without an icon
- Choose an icon that semantically matches the page content
- After adding a new icon to `sidebarIcons.js`, use it immediately in the page frontmatter or `_category_.json`
1 change: 1 addition & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node scripts/check-sidebar-icons.js --staged
2 changes: 2 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 1
slug: /
sidebar_custom_props:
icon: BookOpen
---

# Welcome to QuilrAI Docs
Expand Down
3 changes: 3 additions & 0 deletions docs/llm-gateway/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Unified API gateway for LLM providers - route, secure, monitor, and optimize all your LLM traffic through a single endpoint."
},
"customProps": {
"icon": "BrainCircuit"
}
}
2 changes: 2 additions & 0 deletions docs/llm-gateway/architecture.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 2
sidebar_custom_props:
icon: Layers
---

# Architecture
Expand Down
3 changes: 2 additions & 1 deletion docs/llm-gateway/features/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"description": "Detailed documentation for each LLM Gateway capability - Routing, Token Saving, Guardrails, Prompt Store, Identity Aware, and more."
},
"customProps": {
"badge": "new"
"badge": "new",
"icon": "Sparkles"
}
}
2 changes: 2 additions & 0 deletions docs/llm-gateway/features/custom-intents.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 5
sidebar_custom_props:
icon: Target
---

# Custom Intents
Expand Down
2 changes: 2 additions & 0 deletions docs/llm-gateway/features/identity-aware.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 9
sidebar_custom_props:
icon: Fingerprint
---

# Identity Aware
Expand Down
1 change: 1 addition & 0 deletions docs/llm-gateway/features/prompt-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 7
sidebar_custom_props:
badge: new
icon: MessageSquareText
---

# Prompt Store
Expand Down
2 changes: 2 additions & 0 deletions docs/llm-gateway/features/rate-limits.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 6
sidebar_custom_props:
icon: Gauge
---

# Rate Limits
Expand Down
2 changes: 2 additions & 0 deletions docs/llm-gateway/features/red-team-testing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 8
sidebar_custom_props:
icon: FlaskConical
---

# Red Team Testing
Expand Down
2 changes: 2 additions & 0 deletions docs/llm-gateway/features/request-routing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 1
sidebar_custom_props:
icon: Route
---

# Request Routing
Expand Down
2 changes: 2 additions & 0 deletions docs/llm-gateway/features/security-guardrails.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 4
sidebar_custom_props:
icon: ShieldCheck
---

# Security Guardrails
Expand Down
1 change: 1 addition & 0 deletions docs/llm-gateway/features/token-saving.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 2
sidebar_custom_props:
badge: new
icon: Coins
---

# Token Saving
Expand Down
1 change: 1 addition & 0 deletions docs/llm-gateway/ha-and-sla.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 3
sidebar_custom_props:
badge: new
icon: Activity
---

# HA & SLA
Expand Down
2 changes: 2 additions & 0 deletions docs/llm-gateway/integration-guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 4
sidebar_custom_props:
icon: Plug
---

# Integration Guide
Expand Down
2 changes: 2 additions & 0 deletions docs/llm-gateway/provider-support.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 5
sidebar_custom_props:
icon: Handshake
---

# Provider Support
Expand Down
2 changes: 2 additions & 0 deletions docs/llm-gateway/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 1
sidebar_custom_props:
icon: Rocket
---

# Quick Start
Expand Down
2 changes: 2 additions & 0 deletions docs/llm-gateway/ux-changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 4
sidebar_custom_props:
icon: ClipboardList
---

# UX Changelog
Expand Down
3 changes: 3 additions & 0 deletions docs/mcp-gateway/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Enterprise-grade management layer for MCP servers - install, configure, secure, and monitor MCP integrations used by AI agents."
},
"customProps": {
"icon": "Network"
}
}
2 changes: 2 additions & 0 deletions docs/mcp-gateway/architecture.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 2
sidebar_custom_props:
icon: Layers
---

# Architecture
Expand Down
3 changes: 2 additions & 1 deletion docs/mcp-gateway/features/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"description": "Detailed documentation for each MCP Gateway capability - MCP Library, Tools Management, Guardrails, Access Control, and more."
},
"customProps": {
"badge": "new"
"badge": "new",
"icon": "Sparkles"
}
}
2 changes: 2 additions & 0 deletions docs/mcp-gateway/features/access-control.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 5
sidebar_custom_props:
icon: Lock
---

# Access Control
Expand Down
2 changes: 2 additions & 0 deletions docs/mcp-gateway/features/agents-configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 3
sidebar_custom_props:
icon: Bot
---

# Agents Configuration
Expand Down
2 changes: 2 additions & 0 deletions docs/mcp-gateway/features/api-tokens.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 6
sidebar_custom_props:
icon: KeyRound
---

# API Tokens
Expand Down
1 change: 1 addition & 0 deletions docs/mcp-gateway/features/mcp-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 1
sidebar_custom_props:
badge: new
icon: LibraryBig
---

# MCP Library
Expand Down
2 changes: 2 additions & 0 deletions docs/mcp-gateway/features/oauth-connect.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 7
sidebar_custom_props:
icon: Link
---

# OAuth Connect
Expand Down
2 changes: 2 additions & 0 deletions docs/mcp-gateway/features/security-guardrails.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 4
sidebar_custom_props:
icon: ShieldCheck
---

# Security Guardrails
Expand Down
2 changes: 2 additions & 0 deletions docs/mcp-gateway/features/tools-management.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 2
sidebar_custom_props:
icon: Wrench
---

# Tools Management
Expand Down
1 change: 1 addition & 0 deletions docs/mcp-gateway/features/web-search-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 8
sidebar_custom_props:
badge: new
icon: Globe
---

# Web Search Policy
Expand Down
2 changes: 2 additions & 0 deletions docs/mcp-gateway/integration-guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 3
sidebar_custom_props:
icon: Plug
---

# Integration Guide
Expand Down
2 changes: 2 additions & 0 deletions docs/mcp-gateway/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
sidebar_position: 1
sidebar_custom_props:
icon: Rocket
---

# Quick Start
Expand Down
27 changes: 27 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids"
"write-heading-ids": "docusaurus write-heading-ids",
"check-icons": "node scripts/check-sidebar-icons.js",
"prepare": "husky"
},
"dependencies": {
"@docusaurus/core": "3.9.2",
Expand All @@ -22,6 +24,7 @@
"@fontsource/geist-mono": "^5.2.7",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"lucide-react": "^1.7.0",
"prism-react-renderer": "^2.3.0",
"react": "^19.0.0",
"react-dom": "^19.0.0"
Expand All @@ -31,6 +34,7 @@
"@docusaurus/types": "3.9.2",
"@tailwindcss/postcss": "^4.2.2",
"@tailwindcss/typography": "^0.5.19",
"husky": "^9.1.7",
"tailwindcss": "^4.2.2"
},
"browserslist": {
Expand Down
Loading
Loading