mkdocs.yml

site_name: Pramnos Framework
site_description: A comprehensive PHP MVC framework for building robust, scalable web applications.
site_url: https://mrpc.github.io/PramnosFramework/
repo_url: https://github.com/mrpc/PramnosFramework
repo_name: mrpc/PramnosFramework
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  # Brand assets are synced from brand/ into docs/assets/ before every build
  # (see the dockerdocs script and .github/workflows/docs.yml). The source of
  # truth lives in brand/ — do not edit docs/assets/logo.png directly.
  logo: assets/logo.png
  favicon: assets/favicon.png
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.action.edit

plugins:
  - search:
      lang: en
  - blog:
      blog_dir: version-history
      # NOTE: do NOT set `post_dir` — explicitly setting it (even to its default
      # "posts") breaks post-stream + archive generation in Material 9.7.6.
      # Posts live in version-history/posts/ by default.
      blog_toc: true
      # Date-based changelog: posts form a newest-first stream on the blog index,
      # split across pages by pagination so no single page ever grows huge.
      pagination_per_page: 15

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

nav:
  - Getting Started:
    - Quickstart: index.md
    - Full Setup Guide: Getting_Started.md
  - Version History:
    - Changelog: version-history/index.md
    - Releases: releases.md
    - Upgrade Guide: Pramnos_Upgrade_Guide.md
    - Legacy Permissions Migration: Pramnos_Legacy_Permissions_Migration.md
    - Roadmap & Open Items: Roadmap.md
  - Core Framework:
    - Framework Overview: Pramnos_Framework_Guide.md
    - Application Styles (MVC / SPA / hybrid): Pramnos_Application_Styles_Guide.md
    - Routing: Pramnos_Routing_Guide.md
    - Validation: Pramnos_Validation_System_Guide.md
    - Theming: Pramnos_Theme_Guide.md
    - Internationalization: Pramnos_Internationalization_Guide.md
    - Document Output: Pramnos_Document_Output_Guide.md
    - Environment Variables: Pramnos_Environment_Variables_Guide.md
  - Data Layer:
    - Database API: Pramnos_Database_API_Guide.md
    - Query Builder: Pramnos_QueryBuilder_Guide.md
    - Schema Builder: Pramnos_Schema_Builder_Guide.md
    - ORM: Pramnos_ORM_Guide.md
    - Migrations: Pramnos_Migration_Guide.md
    - Hypertables (TimescaleDB): Pramnos_Hypertable_Guide.md
    - Caching: Pramnos_Cache_Guide.md
    - Redis: Pramnos_Redis_Guide.md
  - Security & Identity:
    - Authentication: Pramnos_Authentication_Guide.md
    - Authorization: Pramnos_Authorization_Guide.md
    - Security Hardening: Pramnos_Security_Guide.md
    - Account & Security (End Users): Pramnos_Account_Guide.md
    - Third-Party Integration: Pramnos_AuthServer_Integration_Guide.md
  - APIs & Integrations:
    - API Guide: Pramnos_API_Guide.md
    - Realtime (SSE & WebSockets): Pramnos_Realtime_Guide.md
    - Queues: Pramnos_Queue_Guide.md
    - Email: Pramnos_Email_Guide.md
    - Media: Pramnos_Media_Guide.md
    - Logging: Pramnos_Logging_Guide.md
  - Operations:
    - Console Commands: Pramnos_Console_Guide.md
    - Workers & Daemons: Pramnos_Workers_And_Daemons_Guide.md
    - Testing: Pramnos_Testing_Guide.md
    - Test suite performance: Pramnos_Test_Suite_Performance.md
    - Debugging: Pramnos_Debugging_Guide.md