Skip to content

Transition from dev container to production container with submodule-based documentation generation #27

@gerchowl

Description

@gerchowl

Feature Request

We need to transition from the current dev container setup to a production-ready container that can be run in a 'central' repository with submodules. The @main.typ file should support narrative text and import statements for submodules, enabling configurable documentation generation based on folder structures.

Use Case

Currently, we're compiling everything inside a dev container for prototyping document generation. This needs to evolve into a production system where:

  • A central repository contains the main documentation structure
  • Submodules can be included via configurable import statements
  • Documentation generation is automated based on folder structures
  • The system supports both default configurations and custom overrides

Proposed Solution

  1. Container Architecture: Create a production container that supports submodule-based documentation
  2. Import System: Implement #include(example/python-project) style imports that can pull documentation from submodules
  3. Configuration: Support configurable documentation generation with sensible defaults
  4. Folder Structure: Define standard folder structures that the system can automatically process
  5. Integration: Ensure compatibility with existing typst-based documentation system

Acceptance Criteria

  • Production container definition (Dockerfile/podman) with proper security and performance optimizations
  • Submodule import mechanism for typst documents
  • Configuration system for documentation generation (YAML/JSON based)
  • Standard folder structure definition and auto-discovery
  • Documentation for setup and usage
  • CI/CD integration for automated builds
  • Example submodule integration demonstrating the workflow

Related Issues

  • This builds upon the current dev container setup in technical-documentations
  • Will require coordination with other MorePET repositories for submodule integration

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions