Clotho
36f790ed22
Added comprehensive documentation for core/cli including: 1. Complete CLI Reference (cli-reference.md) - All 30 commands with detailed descriptions - Subcommands, flags, and usage examples - Organized by category (Development, AI/ML, DevOps, etc.) 2. Build Variants System (build-variants.md) - How to create custom builds (minimal, dev, devops, ai/ml) - Three methods: import commenting, multiple main.go, build tags - External variant repos (core/php, core/ci) - Size optimization and compression tips 3. MCP Integration (mcp-integration.md) - Model Context Protocol server setup - All available tools (file ops, RAG, metrics, process mgmt, WebView/CDP) - Transport modes (stdio, TCP) - Security considerations and workspace restriction - Use cases and troubleshooting 4. Environment Variables (environment-variables.md) - All supported environment variables - Configuration file locations (user, project, registry) - CORE_CONFIG_* mapping system - Service-specific vars (MCP, RAG, ML, Git, etc.) - Best practices and troubleshooting 5. Updated Navigation - Enhanced cmd/index.md with categories and quick links - Updated mkdocs.yml with new documentation pages Fixes #4 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
109 lines
3 KiB
YAML
109 lines
3 KiB
YAML
site_name: Core Framework
|
|
site_url: https://core.help
|
|
site_description: 'A Web3 Framework for building Go desktop applications with Wails v3'
|
|
site_author: 'Snider'
|
|
repo_url: 'https://forge.lthn.ai/core/go'
|
|
repo_name: 'host-uk/core'
|
|
|
|
theme:
|
|
name: material
|
|
palette:
|
|
- scheme: default
|
|
primary: deep purple
|
|
accent: purple
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- scheme: slate
|
|
primary: deep purple
|
|
accent: purple
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.top
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.tabs.link
|
|
- content.code.copy
|
|
|
|
markdown_extensions:
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- admonition
|
|
- pymdownx.details
|
|
- attr_list
|
|
- md_in_html
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- User Documentation:
|
|
- User Guide: user-guide.md
|
|
- FAQ: faq.md
|
|
- Troubleshooting: troubleshooting.md
|
|
- Workflows: workflows.md
|
|
- CLI Reference:
|
|
- Overview: cmd/index.md
|
|
- Complete Reference: cli-reference.md
|
|
- Build Variants: build-variants.md
|
|
- MCP Integration: mcp-integration.md
|
|
- Environment Variables: environment-variables.md
|
|
- Commands:
|
|
- AI: cmd/ai/index.md
|
|
- Build: cmd/build/index.md
|
|
- CI: cmd/ci/index.md
|
|
- Dev: cmd/dev/index.md
|
|
- Go: cmd/go/index.md
|
|
- PHP: cmd/php/index.md
|
|
- SDK: cmd/sdk/index.md
|
|
- Setup: cmd/setup/index.md
|
|
- Doctor: cmd/doctor/index.md
|
|
- Test: cmd/test/index.md
|
|
- VM: cmd/vm/index.md
|
|
- Pkg: cmd/pkg/index.md
|
|
- Docs: cmd/docs/index.md
|
|
- Getting Started:
|
|
- Installation: getting-started/installation.md
|
|
- Quick Start: getting-started/quickstart.md
|
|
- Architecture: getting-started/architecture.md
|
|
- Core Framework:
|
|
- Overview: core/overview.md
|
|
- Services: core/services.md
|
|
- Lifecycle: core/lifecycle.md
|
|
- IPC & Actions: core/ipc.md
|
|
- Services:
|
|
- Config: services/config.md
|
|
- Display: services/display.md
|
|
- WebView: services/webview.md
|
|
- MCP: services/mcp.md
|
|
- Crypt: services/crypt.md
|
|
- I18n: services/i18n.md
|
|
- IO: services/io.md
|
|
- Workspace: services/workspace.md
|
|
- Help: services/help.md
|
|
- Extensions:
|
|
- Plugin System: extensions/plugins.md
|
|
- Module System: extensions/modules.md
|
|
- GUI Application:
|
|
- Overview: gui/overview.md
|
|
- MCP Bridge: gui/mcp-bridge.md
|
|
- API Reference:
|
|
- Core: api/core.md
|
|
- Display: api/display.md
|
|
- Development:
|
|
- Package Standards: pkg/PACKAGE_STANDARDS.md
|
|
- Internationalization:
|
|
- Overview: pkg/i18n/README.md
|
|
- Grammar: pkg/i18n/GRAMMAR.md
|
|
- Extending: pkg/i18n/EXTENDING.md
|
|
- Claude Skill: skill/index.md
|
|
- Reference:
|
|
- Configuration: configuration.md
|
|
- Migration: migration.md
|
|
- Glossary: glossary.md
|