Skip to content

Portugal Odyssey Platform Documentation

Welcome to the Portugal Odyssey platform documentation. This documentation is organized by audience to help you quickly find what you need.

Quick Navigation

👨‍💻 For Developers

Complete guides for developing, extending, and contributing to the platform. - Getting started with local development - Service architecture and APIs - Frontend development guides - Troubleshooting common issues

🔧 For DevOps

Deployment, infrastructure, and operations documentation. - Deployment guides (Dev/Qual/Prod) - Infrastructure setup and configuration - CI/CD pipelines - Monitoring and operations

👥 For Clients & Stakeholders

Non-technical overview and feature documentation. - Platform overview - Feature documentation - Release notes and changelogs

📚 Reference Material

Quick reference guides, glossaries, and technical specifications. - System URLs & Access - API reference - Environment variables - Makefile commands - Glossary

Documentation Structure

docs/
├── developers/          # Development guides and API documentation
├── devops/             # Deployment and infrastructure guides
├── clients/            # Client-facing documentation
├── reference/          # Quick reference materials
└── archive/            # Deprecated and historical documentation

Getting Started

New to the project? - Start with Developer Getting Started - Or check the Platform Overview

Setting up infrastructure? - See DevOps Deployment Guide

Looking for specific information? - Use the Glossary for terminology - Check Reference Materials for quick lookups

Contributing to Documentation

We welcome contributions! See CONTRIBUTING.md for: - Documentation standards - How to add or update docs - Review process

Search Tips

  • By Service: Check developers/services/[service-name]/
  • By Topic: Use the audience-specific READMEs for topic navigation
  • By Environment: See devops/deployment/environments.md
  • Quick Reference: Check reference/ for command references and glossaries

Context for AI Agents

This documentation is structured to help AI agents understand the platform:

  • Metadata: Each document includes YAML frontmatter with audience, category, and related docs
  • Consistent Structure: Standardized heading hierarchy and formatting
  • Cross-References: Related documents are linked throughout
  • Glossary: Centralized terminology in reference/glossary.md

See AI Agent Guide for: - How to prompt AI agents effectively - What context to provide - Where to save generated documentation - Best practices for AI agent interactions

When answering questions about the platform: 1. Check the audience-specific sections first 2. Use the glossary for term definitions 3. Follow cross-references to related topics 4. Consider the context (development vs. operations vs. client)

Last Updated: November 25, 2025