Skip to content

Update docs structure when DR-008-infra solution is implemented #136

Description

@ryan-steel

Description

The current implementation uses source_dir = "." with conf.py and index.rst at the repo root as a workaround based on DR-008-infra. When the infrastructure team implements the proper solution for including component documentation, we should update to use that canonical approach.

Context

  • Current workaround: source_dir = "." with conf.py/index.rst at root and include_patterns filtering
  • Blocked by: Infrastructure team implementation of DR-008-infra solution
  • Related PR: Add user manuals for time module #133

Acceptance Criteria

  • Monitor DR-008-infra for infrastructure team solution
  • Update docs structure to use the canonical approach for including component docs
  • Move conf.py and index.rst back to docs/ if possible
  • Update BUILD configuration accordingly

Blocked By

Infrastructure team implementation of DR-008-infra - see eclipse-score/docs-as-code#554

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Fields

    No fields configured for Task.

    Projects

    Status
    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions