385d2cf386
- Add complete API documentation and architecture guides - Include quick start, installation, and deployment guides - Add troubleshooting and security documentation - Include CLI reference and configuration schema docs - Add production monitoring and operations guides - Implement MkDocs configuration with search functionality - Include comprehensive user and developer documentation Provides complete documentation for users and developers covering all aspects of the FetchML platform.
88 lines
1.5 KiB
YAML
88 lines
1.5 KiB
YAML
# GitHub Pages configuration
|
|
|
|
# Site settings
|
|
title: "Fetch ML Documentation"
|
|
description: "Secure Machine Learning Platform"
|
|
baseurl: "/fetch_ml"
|
|
url: "https://fetch-ml.github.io"
|
|
|
|
# Build settings
|
|
markdown: kramdown
|
|
highlighter: rouge
|
|
theme: minima
|
|
plugins:
|
|
- jekyll-sitemap
|
|
- jekyll-feed
|
|
- jekyll-optional-front-matter
|
|
- jekyll-readme-index
|
|
- jekyll-titles-from-headings
|
|
- jekyll-seo-tag
|
|
|
|
# Versioning
|
|
version: "1.0.0"
|
|
versions:
|
|
- "1.0.0"
|
|
- "0.9.0"
|
|
latest_version: "1.0.0"
|
|
|
|
# Navigation
|
|
nav:
|
|
- title: "Getting Started"
|
|
subnav:
|
|
- title: "Quick Start"
|
|
url: "/quick-start/"
|
|
- title: "Guides"
|
|
subnav:
|
|
- title: "CLI Reference"
|
|
url: "/cli-reference/"
|
|
- title: "Architecture"
|
|
url: "/architecture/"
|
|
- title: "Server Setup"
|
|
url: "/server-setup/"
|
|
- title: "Development"
|
|
subnav:
|
|
- title: "Contributing"
|
|
url: "/contributing/"
|
|
- title: "API Reference"
|
|
url: "/api/"
|
|
|
|
# Collections
|
|
collections:
|
|
docs:
|
|
output: true
|
|
permalink: /:collection/:name/
|
|
api:
|
|
output: true
|
|
permalink: /api/:name/
|
|
|
|
# Exclude files from processing
|
|
exclude:
|
|
- Gemfile
|
|
- Gemfile.lock
|
|
- node_modules
|
|
- vendor
|
|
- .gitignore
|
|
- README.md
|
|
- Makefile
|
|
|
|
# Include files
|
|
include:
|
|
- _pages
|
|
|
|
# SEO
|
|
author: "Fetch ML Team"
|
|
twitter:
|
|
username: "fetch_ml"
|
|
card: "summary"
|
|
|
|
# Google Analytics (optional)
|
|
google_analytics: ""
|
|
|
|
# Mermaid diagrams for architecture
|
|
mermaid:
|
|
enabled: true
|
|
|
|
# Code highlighting
|
|
kramdown:
|
|
input: GFM
|
|
syntax_highlighter: rouge
|