Navigation Template for OHEMR Infrastructure Repositories (-001)

This template provides a standardized navigation structure that separates:

1. Operational/Architectural Documentation (human-authored)
2. Technical Documentation (auto-generated via terraform-docs)

TEMPLATE NAVIGATION STRUCTURE

Replace {PLACEHOLDERS} with repository-specific content

nav:

---------------------------------------------------------------------------

Overview & Getting Started

---------------------------------------------------------------------------

• Home:
  • 'index.md'
  • Repository Overview: 'README.md'
  • Quick Start: 'getting-started/quick-start.md'
  • Contributing: 'CONTRIBUTING.md'
  • Changelog: 'CHANGELOG.md'

---------------------------------------------------------------------------

Architecture & Design

---------------------------------------------------------------------------

• Architecture:
  • 'architecture/index.md'
  • Overview: 'architecture/overview.md'
  • Components: 'architecture/components.md'
  • Regional Deployment: 'architecture/regional-deployment.md'
  • Dependencies: 'architecture/dependencies.md'

---------------------------------------------------------------------------

Operations & Procedures

---------------------------------------------------------------------------

• Operations:
  • 'operations/index.md'
  • Deployment Guide: 'operations/deployment.md'
  • Monitoring: 'operations/monitoring.md'
  • Troubleshooting: 'operations/troubleshooting.md'
  • Emergency Procedures: 'operations/emergency-procedures.md'

---------------------------------------------------------------------------

Technical Reference (Auto-Generated)

terraform-docs generated content

---------------------------------------------------------------------------

• Technical Reference:

  • 'terraform/index.md'

  • Infrastructure Overview: 'terraform/overview.md'

    Auto-generated terraform-docs content

    Pattern: terraform/{workspace-name}/README{workspace-name}.md

REPOSITORY-SPECIFIC CUSTOMIZATIONS

ohemr-epic-npd-001

- Add "Tagging Reference" section for HCP v1.8 compliance

- Include NPD-specific testing procedures

ohemr-epic-pro-001

- Add production-specific safety warnings

- Include change management procedures

ohemr-connectivity-pro-001

- Add network-specific sections (DNS, ExpressRoute, Firewalls)

- Include connectivity troubleshooting

ohemr-citrix-shared-001

- Add Citrix-specific sections (VDI, NetScaler)

- Include .auto.tfvars configuration patterns