76332b0f02
* docs: add user guide, faq, and enhance troubleshooting - Created docs/user-guide.md with key concepts and workflows. - Created docs/faq.md with common questions and answers. - Enhanced docs/troubleshooting.md with AI/Agentic issues. - Updated README.md with CLI Quick Start and Getting Help sections. - Refactored mkdocs.yml to reflect actual file structure and include new docs. * docs: add user documentation and fix mkdocs navigation - Created docs/user-guide.md and docs/faq.md. - Enhanced docs/troubleshooting.md with AI/Agentic issues. - Updated README.md with CLI Quick Start and Help links. - Restored original mkdocs.yml navigation and added new user documentation sections. - Fixed formatting in pkg/io/local/client.go to ensure CI passes. * docs: add user documentation and fix auto-merge workflow - Created docs/user-guide.md and docs/faq.md with user-focused content. - Enhanced docs/troubleshooting.md with AI/Agentic issue solutions. - Updated README.md with CLI Quick Start and organized help links. - Refactored mkdocs.yml to include new documentation while preserving technical sections. - Fixed .github/workflows/auto-merge.yml by inlining the logic and adding git repository context (checkout and -R flag) to resolve CI failures. - Verified that docs/workflows.md is present in the repository. * docs: add user documentation and resolve merge conflict - Created docs/user-guide.md and docs/faq.md. - Enhanced docs/troubleshooting.md with AI/Agentic issue solutions. - Updated README.md with CLI Quick Start and Help sections. - Merged latest base branch changes and resolved conflict in .github/workflows/auto-merge.yml. - Verified and organized mkdocs.yml navigation. * docs: add user documentation and fix UniFi security issue - Created docs/user-guide.md and docs/faq.md. - Enhanced docs/troubleshooting.md. - Updated README.md with CLI Quick Start. - Fixed UniFi security vulnerability (CodeQL alert) by making TLS verification configurable. - Added --insecure flag to UniFi CLI commands. - Verified all documentation links and navigation. * docs: add user documentation and fix formatting/security - Created docs/user-guide.md and docs/faq.md. - Enhanced docs/troubleshooting.md. - Updated README.md with CLI Quick Start. - Fixed UniFi security vulnerability by making TLS verification configurable. - Added --insecure flag to UniFi CLI commands. - Fixed formatting in internal/cmd/unifi/cmd_config.go. - Verified all documentation links and navigation. --------- Co-authored-by: Claude <developers@lethean.io>
110 lines
3.1 KiB
YAML
110 lines
3.1 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://github.com/host-uk/core'
|
|
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
|
|
- 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
|
|
- Architecture Decisions:
|
|
- Overview: adr/README.md
|
|
- "ADR 0001: Use Wails v3": adr/0001-use-wails-v3.md
|
|
- "ADR 0002: IPC Bridge Pattern": adr/0002-ipc-bridge-pattern.md
|
|
- "ADR 0003: Service Pattern": adr/0003-soa-dual-constructor-di.md
|
|
- "ADR 0004: Storage Abstraction": adr/0004-storage-abstraction-medium.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
|