Repository Navigation and Directory Guides

Table of Contents

• 1. Top-Level Repository Areas
• 2. Top-Level Guide Links
• 3. Configuration Subdirectory Guides
• 4. Example Case Guides
• 5. Documentation-Local Guides
• 6. Documentation Organization Rules
• 7. Related Documentation

This page is the documentation map of the repository layout. Use it as the single directory-guide index so internal guide.md files do not need to appear as standalone documentation pages.

1. Top-Level Repository Areas

• Configuration library: <repo>/config/
• Documentation source: docs/
• Runnable templates: examples/
• Public headers: include/
• C source implementation: src/
• Python conductor package and source-tree entrypoint: picurv_cli/
• Tests and fixtures: tests/
• Developer scratch area: sandbox/
• Logs and warnings: <repo>/logs/
• GitHub workflow definitions: .github/

2. Top-Level Guide Links

• Configuration Guide
• Documentation Guide
• Examples Guide
• Include Guide
• Source Guide
• Generators Guide
• PICurv CLI Package Guide
• Tests Guide
• Smoke Test Guide
• Test Tooling Guide
• Sandbox Guide
• Logs Guide
• GitHub Workflows Guide

3. Configuration Subdirectory Guides

• Build Config Guide
• Grid Config Library Guide
• Initial Condition Profiles Guide
• Monitor Profiles Guide
• Solver Profiles Guide
• Postprocessor Profiles Guide
• Composable Profiles Guide
• Runtime Config Guide
• Scheduler Profiles Guide
• Study Config Guide

4. Example Case Guides

• Bent Channel Guide
• Flat Channel Guide
• Master Template Guide

5. Documentation-Local Guides

• Pages Authoring Guide
• Assets Guide

6. Documentation Organization Rules

1. Repository-level conceptual docs should live in docs/pages/ as @page entries.
2. Directory orientation notes should live in local guide.md files.
3. Directory guides are indexed from this page, not promoted to top-level docs navigation.
4. When adding a major new directory, add a guide.md and add a link here.

7. Related Documentation

• Quick Start
• User Guide
• Developer Portal