mkdocs.yml

site_name: "Common Object Management Service"
site_description: "A microservice for managing access control to S3 Objects"
docs_dir: "docs"
repo_url: "https://github.com/bcgov/common-object-management-service-docs"
edit_uri: edit/main/docs
plugins:
    - techdocs-core
    - git-revision-date-localized
markdown_extensions:
    - md_in_html
    - toc:
        permalink: "#"
nav:
- Introduction: index.md
- API User Guide:
  - Authentication: Authentication.md
  - Endpoint Notes: Endpoint-Notes.md
  - Permissions: Permissions.md
  - Metadata and Tags: Metadata-Tag.md
  - Managing buckets: Buckets.md
  - Synchronization: Synchronization.md
  - Use-Case Examples: Use-Case-Examples.md
- Deployment Guide:
  - Self-Hosting COMS: Self-Hosting-COMS.md 
  - Architecture: 
    - Overview: Architecture.md
    - Database: Architecture/#database-structure
    - Code Design: Architecture/#code-design
  - Configuration Options: Config.md
- The Hosted Service:
  - Hosting Considerations: Hosting-Considerations.md 
  - Hosted Service Architecture: Architecture-Hosted.md
  - Hosted Service Onboarding: Hosted-Service-Onboarding.md
- Product Roadmap: Product-Roadmap.md