mkdocs.yml

# Copyright 2026 Firefly Software Foundation. SPDX-License-Identifier: Apache-2.0
site_name: firefly forge
site_url: https://fireflyframework.github.io/firefly-forge/
site_description: Build and verify software with Firefly's software factory.
site_author: Firefly Software Foundation
repo_url: https://github.com/fireflyframework/firefly-forge
repo_name: Source code
edit_uri: edit/main/docs/
copyright: Copyright © 2026 Firefly Software Foundation
strict: true
docs_dir: docs
site_dir: build/docs-site
theme:
  name: material
  font: false
  logo: assets/forge-lockup.svg
  favicon: assets/favicon.svg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark appearance
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light appearance
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.footer
    - navigation.tracking
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
plugins:
  - search
markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra:
  generator: false
  discovery:
    font: assets/fonts/manrope-latin-wght-normal.woff2
    logo: assets/forge-lockup-light.svg
    notice: assets/NOTICE.txt
    font_notice: assets/fonts/OFL.txt
extra_css:
  - stylesheets/forge.css
nav:
  - Start:
      - Documentation home: index.md
      - Find your next step: guide.md
      - Concepts and factory journeys: factory-journeys.md
      - Install and start: installation.md
      - Your first product: quickstart.md
      - Studio console tour: console-tour.md
      - Capabilities and limits: capabilities.md
  - Products:
      - Define a product: product-definition.md
      - Change features and integrations: product-lifecycle.md
      - Review existing-project knowledge: as-is-handoff.md
      - Architecture and brand: product-design.md
      - Review wireframes: design-review.md
      - pyfly walkthrough: pyfly.md
      - larafly walkthrough: larafly.md
      - Choose a stack: profiles.md
      - Build, maintain and test: workflows.md
      - Coordinate project campaigns: project-campaigns.md
      - Delivery assurance: assurance.md
  - Agents:
      - Choose an agent: agents.md
      - Assign models by task: model-profiles.md
      - Agent roles and feedback: agent-roles.md
      - Maintain model instructions: prompt-templates.md
      - Lifecycle phases: agent-lifecycle.md
      - Retained run evidence: run-evidence.md
      - Agent tools: agent-tools.md
      - Tool and provider prerequisites: tooling-prerequisites.md
      - External tool setup walkthrough: external-tools-tour.md
      - Authorize connected accounts: connected-accounts.md
      - Configure internet search: search-providers.md
      - Tool invocation evidence: tool-broker.md
      - Reviewed external tools: external-tools.md
      - CLI, SDK and MCP clients: agent-integrations.md
      - Files in AI conversations: assistant-files.md
      - Configure provider access: configuration.md
      - Configure execution runners: sandbox.md
      - Review browser journeys: browser-qa.md
      - Project and central policies: policies.md
      - Agent bridge connection: bridge.md
  - Integrations:
      - Connect Git repositories: scm.md
      - Repository conversations: repository-workflow.md
      - Cited knowledge and memory: knowledge.md
      - Structured analytics architecture: structured-knowledge.md
      - Learning and knowledge reuse: learning.md
      - DevSecOps pipelines: devsecops.md
  - Operations:
      - Operations: operations.md
      - Factory infrastructure and clusters: factory-infrastructure.md
      - API and worker roles: runtime-roles.md
      - Recover and hand off: recovery.md
      - Deploy and roll back: deployment.md
      - Cloud and infrastructure recipes: cloud-deployment.md
      - Application health and maintenance: application-operations.md
      - Security: security.md
      - Sign in and manage project access: identity.md
      - Add and manage users: user-administration.md
  - Reference:
      - Architecture: architecture.md
      - HTTP API: api.md
      - Release notes: release-notes.md
      - Contribute: contributing.md
      - Brand and visual assets: brand.md
      - Publish documentation: documentation-publishing.md

hooks:
  - scripts/docs_scene_hook.py
  - scripts/docs_discovery_hook.py