opensource/cline
3
0
Fork 0
mirror of https://github.com/cline/cline.git synced 2026-09-14 02:29:17 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
51cfd464cd9e3d6b2fc26a588f7fc96dfc9e7bb2
cline/docs/docs.json
T
Juan Pablo FloresandCopilot 8f8c4561a6 Docs upgrade (#6907) 
* style(docs): update background color scheme to neutral tones

Update documentation background colors from purple-tinted theme to neutral gray tones. Changed light mode from lavender (#F0E6FF) to off-white (#fafaf9) and dark mode from pure black (#000000) to dark gray (#0f0f0f) for improved visual consistency.

* refactor(docs): remove gradient decoration from theme config

Remove the "decoration": "gradient" property from the documentation
theme configuration. This simplifies the theme settings by removing
the gradient decoration option from the color configuration object.

* docs: change documentation font family to Geist Mono

Replace Roboto with Geist Mono as the default font family in the documentation configuration. This updates the visual styling of the documentation to use a monospace font, which may improve readability for code-heavy content.

* docs: update branding and restructure navigation

- Replace robot panel logos with new Cline brand logos
- Add icons to navbar links (Docs, GitHub, Discord)
- Restructure navigation from groups to tabs format
- Add icons to navigation items for improved UX
- Include new Docs link in navbar with book icon

This update modernizes the documentation appearance and improves navigation hierarchy for better user experience.

* docs: restructure navigation with hierarchical groups and pages

Restructured documentation navigation from flat menu to organized groups:
- Removed redundant "Docs" link from navbar
- Migrated from "menu" to "groups/pages" structure
- Added comprehensive page organization with nested groups:
  * Introduction, Getting Started, Features
  * Prompting Skills, Cline's Tools, Enterprise Solutions
  * MCP Servers, Provider Configuration
- Organized features into logical subgroups (@ Mentions, Commands,
  Customization, Slash Commands)
- Improved documentation discoverability and hierarchy

This change provides better content organization and easier navigation
for users exploring different aspects of Cline documentation.

* docs: remove contextual options from documentation config

Remove the contextual configuration section containing the "copy" option from docs.json. This simplifies the documentation configuration by removing unused contextual menu options.

* docs(multiroot): improve workspace documentation with limitations and technical details

- Add important note about experimental limitations affecting Cline rules and checkpoints
- Add "How it works" section explaining automatic workspace detection and tracking
- Reorganize technical behavior section with detailed subsections for workspace detection, path resolution, and command execution
- Document workspace hint syntax for explicit file references (@workspaceName:path)
- Standardize heading capitalization to sentence case for consistency
- Improve overall content organization and clarity for better user understanding

This update provides users with clearer information about the multiroot feature's current state, its limitations, and how to effectively use workspace hints when working with multiple project folders.

* docs: restructure overview page with enhanced visual layout

- Convert plain markdown sections to CardGroup and Card components with icons
- Add tabbed interface for Plan & Act Mode explanation
- Update description from "development assistant" to "coding agent"
- Reorganize content for improved readability and visual hierarchy
- Enhance feature presentations with icon-based cards

Improves user experience by transforming the overview documentation into a more visually appealing and scannable format using modern documentation components.

* docs: improve installation guide with enhanced structure and UX

Restructure the Cline installation documentation to improve readability and user experience:

- Add prominent note highlighting 2-minute installation time
- Convert prerequisites into visual card components for better clarity
- Transform installation steps into structured Step components for easier following
- Add manual installation instructions for JetBrains IDEs
- Include feature compatibility accordion for JetBrains users
- Enhance visual hierarchy with improved component usage (CardGroup, Steps, Accordion)
- Simplify language and improve descriptions throughout

This makes the installation process clearer for new users and reduces friction during onboarding.

* style(docs): remove text opacity reduction for better readability

* docs: refactor model selection guide with visual step-by-step instructions

- Replace tab-based layout with linear step-by-step flow
- Add screenshots for each configuration step (config, provider, API, model)
- Reorganize content structure for improved clarity and user experience
- Add quickstart options and streamlined provider recommendations
- Improve navigation with visual aids to help users configure Cline faster

* docs: add installation screenshots and context management guide

* docs: flatten provider config structure in documentation

Remove the "Alternative Providers" grouping and move all provider configuration pages (OpenRouter, Cerebras, DeepSeek, Groq, xAI Grok, Mistral AI, Doubao, Fireworks, and ZAI) to the main provider configuration list. This simplifies the documentation navigation by treating all providers equally rather than categorizing some as alternatives.

* docs: restructure context management docs and improve content clarity

**Changes:**
- Reorganized documentation structure by moving context management from
  `/best-practices` to `/prompting` section for better categorization
- Added URL redirect to maintain backward compatibility for old links
- Updated navigation references in welcome page to point to new location
- Improved readability of context management explanations with more
  narrative, conversational prose
- Enhanced context window documentation by adding cache tokens indicator
  and using emoji-based formatting for better visual clarity
- Streamlined Cline Memory Bank setup instructions from 4 to 3 steps
- Updated context bar screenshot to use newer image asset

**Why:**
Better documentation organization and improved user experience through
clearer explanations of how Cline builds and manages context during tasks.

* docs(context-management): convert Quick Reference to Info component

Replace blockquote formatting with Info component for the Quick Reference
section in the context management documentation. This improves visual
presentation and maintains consistency with documentation standards.

Also removes trailing whitespace at the end of the file for cleaner
formatting.

* docs: add Cline Enterprise overview and restructure enterprise section

- Add comprehensive enterprise overview documentation covering security,
  governance, observability, and developer experience features
- Rename "Enterprise & Security" navigation group to "Enterprise"
- Consolidate enterprise documentation by replacing 4 pages with 2:
  new overview page and security concerns
- Document BYOI (Bring Your Own Inference), SSO authentication, and
  role-based access control capabilities

This restructuring provides a clearer entry point for enterprise users
and consolidates previously scattered enterprise information into a
cohesive overview document.

* docs(enterprise): streamline enterprise overview and update font

- Change documentation font from Geist Mono to Geist Sans
- Add enterprise website link card for detailed information
- Remove Developer Experience, Proven at Scale, and Pricing sections
- Consolidate Flexible Inference section content
- Simplify enterprise overview to focus on core capabilities

These changes reduce redundancy by directing users to the enterprise
website for pricing and detailed features while keeping the docs
focused on technical implementation and core capabilities.

* clean-images

* Update docs/getting-started/installing-cline.mdx

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update docs/styles.css

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* docs(cline-cli): add platform availability warning to overview

Add a prominent warning callout indicating that Cline CLI is currently in preview and only supports macOS and Linux, with Windows support coming soon. This sets clear expectations for users about platform compatibility.

Also remove redundant introductory text in the "What you can build with this" section to improve content clarity.

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-10-16 11:51:20 -07:00

324 lines
8.0 KiB
JSON
Raw Blame History

{
"$schema": "https://mintlify.com/docs.json",
"theme": "linden",
"name": "Cline",
"description": "AI-powered coding agent for complex work",
"colors": {
"primary": "#9D4EDD",
"light": "#F0E6FF",
"dark": "#000000"
},
"logo": {
"light": "/assets/Cline_Logo-complete_black.png",
"dark": "/assets/Cline_Logo-complete_white.png"
},
"favicon": {
"light": "/assets/robot_panel_light.png",
"dark": "/assets/robot_panel_dark.png"
},
"background": {
"color": {
"light": "#fafaf9",
"dark": "#0f0f0f"
}
},
"styling": {
"eyebrows": "breadcrumbs",
"codeblocks": "system",
"css": "styles.css"
},
"appearance": {
"default": "system",
"strict": false
},
"fonts": {
"family": "Geist Sans"
},
"navbar": {
"links": [
{
"label": "GitHub",
"icon": "github",
"href": "https://github.com/cline/cline"
},
{
"label": "Discord",
"icon": "discord",
"href": "https://discord.gg/cline"
}
],
"primary": {
"type": "button",
"label": "Install Cline",
"href": "https://cline.bot/install?utm_source=website&utm_medium=header"
}
},
"navigation": {
"tabs": [
{
"tab": "Docs",
"icon": "square-terminal",
"groups": [
{
"group": "Introduction",
"pages": [
"introduction/welcome",
"introduction/overview"
]
},
{
"group": "Getting Started",
"pages": [
"getting-started/installing-cline",
"getting-started/selecting-your-model",
"getting-started/your-first-project"
]
},
{
"group": "Best Practices",
"pages": [
"prompting/understanding-context-management",
"prompting/prompt-engineering-guide",
"prompting/cline-memory-bank"
]
},
{
"group": "CLI",
"pages": [
"cline-cli/overview",
"cline-cli/installation",
"cline-cli/three-core-flows",
"cline-cli/cli-reference"
]
},
{
"group": "Features",
"pages": [
{
"group": "@ Mentions",
"pages": [
"features/at-mentions/overview",
"features/at-mentions/file-mentions",
"features/at-mentions/terminal-mentions",
"features/at-mentions/problem-mentions",
"features/at-mentions/git-mentions",
"features/at-mentions/url-mentions"
]
},
"features/auto-approve",
"features/auto-compact",
"features/checkpoints",
"features/cline-rules",
{
"group": "Commands & Shortcuts",
"pages": [
"features/commands-and-shortcuts/overview",
"features/commands-and-shortcuts/code-commands",
"features/commands-and-shortcuts/terminal-integration",
"features/commands-and-shortcuts/git-integration",
"features/commands-and-shortcuts/keyboard-shortcuts"
]
},
{
"group": "Customization",
"pages": [
"features/customization/opening-cline-in-sidebar",
"features/customization/disable-terminal-pagers"
]
},
"features/dictation",
"features/drag-and-drop",
"features/editing-messages",
"features/focus-chain",
"features/multiroot-workspace",
"features/plan-and-act",
{
"group": "Slash Commands",
"pages": [
"features/slash-commands/new-task",
"features/slash-commands/new-rule",
"features/slash-commands/smol",
"features/slash-commands/report-bug",
"features/slash-commands/deep-planning"
]
},
"features/slash-commands/workflows",
{
"group": "Task Management",
"pages": [
"features/tasks/understanding-tasks",
"features/tasks/task-management"
]
},
"features/yolo-mode"
]
},
{
"group": "Model & Provider Configuration",
"pages": [
{
"group": "Model Selection",
"pages": [
"core-features/model-selection-guide",
"model-config/model-comparison",
"model-config/context-windows"
]
},
{
"group": "Cloud Providers",
"pages": [
"provider-config/anthropic",
"provider-config/claude-code",
"provider-config/openai",
"provider-config/openrouter",
"provider-config/cerebras",
"provider-config/deepseek",
"provider-config/groq",
"provider-config/xai-grok",
"provider-config/mistral-ai",
"provider-config/doubao",
"provider-config/fireworks",
"provider-config/zai",
"provider-config/gcp-vertex-ai",
{
"group": "AWS Bedrock",
"pages": [
"provider-config/aws-bedrock/api-key",
"provider-config/aws-bedrock/iam-credentials",
"provider-config/aws-bedrock/cli-profile"
]
}
]
},
{
"group": "Running Models Locally",
"pages": [
"running-models-locally/overview",
"running-models-locally/ollama",
"running-models-locally/lm-studio"
]
},
{
"group": "Advanced Configuration",
"pages": [
"provider-config/openai-compatible",
"provider-config/litellm-and-cline-using-codestral",
"provider-config/vscode-language-model-api",
"provider-config/sap-aicore",
"provider-config/vercel-ai-gateway",
"provider-config/requesty",
"provider-config/baseten"
]
}
]
},
{
"group": "MCP Integration",
"pages": [
"mcp/mcp-overview",
"mcp/adding-mcp-servers-from-github",
"mcp/configuring-mcp-servers",
"mcp/connecting-to-a-remote-server",
"mcp/mcp-marketplace",
"mcp/mcp-server-development-protocol",
"mcp/mcp-transport-mechanisms"
]
},
{
"group": "Cline Tools Reference",
"pages": [
"exploring-clines-tools/cline-tools-guide",
"exploring-clines-tools/new-task-tool",
"exploring-clines-tools/remote-browser-support"
]
},
{
"group": "Enterprise",
"pages": [
"enterprise-solutions/overview",
"enterprise-solutions/security-concerns"
]
},
{
"group": "Reference",
"pages": [
"troubleshooting/terminal-quick-fixes",
"troubleshooting/terminal-integration-guide",
"more-info/telemetry"
]
}
]
},
{
"tab": "Learn",
"icon": "graduation-cap",
"href": "https://cline.bot/learn"
},
{
"tab": "Blog",
"icon": "newspaper",
"href": "https://cline.bot/blog"
}
]
},
"footer": {
"socials": {
"x": "https://x.com/cline",
"github": "https://github.com/cline/cline",
"discord": "https://discord.gg/cline"
}
},
"anchors": [
{
"name": "Overview",
"icon": "house",
"url": "introduction/overview"
}
],
"redirects": [
{
"source": "/getting-started/installing-cline-jetbrains",
"destination": "/getting-started/installing-cline"
},
{
"source": "/getting-started/what-is-cline",
"destination": "/introduction/overview"
},
{
"source": "/getting-started/overview",
"destination": "/introduction/overview"
},
{
"source": "/introduction",
"destination": "/introduction/welcome"
},
{
"source": "/getting-started/model-selection-guide",
"destination": "/core-features/model-selection-guide"
},
{
"source": "/provider-config/ollama",
"destination": "/running-models-locally/ollama"
},
{
"source": "/running-models-locally/read-me-first",
"destination": "/running-models-locally/overview"
},
{
"source": "/getting-started/understanding-context-management",
"destination": "/prompting/understanding-context-management"
},
{
"source": "/best-practices/understanding-context-management",
"destination": "/prompting/understanding-context-management"
},
{
"source": "/getting-started/your-first-task",
"destination": "/getting-started/your-first-project"
}
],
"search": {
"prompt": "Search Cline documentation..."
}
}
Reference in New Issue View Git Blame Copy Permalink