Skip to content

Define TRURL workspace manifest format #8

Description

@sigilabcodex

Purpose

Define a tentative trurl.workspace.yaml format for opening multi-root editorial workspaces without forcing existing projects to migrate into TRURL's internal demo conventions.

The manifest should make heterogeneous literary/editorial folders legible to TRURL while staying readable to humans.

Initial target

Support a workspace like:

/media/diegom/luna/DEV/0w

with projects such as:

  • fiction/horror/los-andares-del-diablo
  • fiction/horror/los-andares-del-diablo/stories/la-pura-y-fria-obscuridad
  • fiction/horror/los-andares-del-diablo/stories/enterrentario
  • fiction/science-fiction/anatomistas
  • fiction/science-fiction/cuencas-confederadas
  • fiction/lab
  • d-503
  • art-as-engineered-experience
  • cartografia-de-la-impunidad

Manifest should support

  • Multiple roots.
  • Relative paths.
  • Human-readable labels.
  • Project kinds, such as fiction_collection, story, fiction_project, essay_series, corpus_lab, research_report, art_project.
  • Parent/child relationships.
  • Internal Git repositories.
  • Folder role mappings.
  • Scanner hints.
  • Derived/dist folders.
  • Default UI views.
  • Writer-facing terminology.

Acceptance criteria

  • Draft trurl.workspace.yaml format is documented.
  • Example manifest for /media/diegom/luna/DEV/0w exists.
  • Required vs optional fields are documented.
  • Git modes are documented, e.g. repo, inherit, none, unknown.
  • Folder roles are documented, e.g. manuscript, drafts, final, working, canon, planning, research, assets, prompts, derived, published.
  • JSON schema or validation plan is proposed.
  • No runtime behavior change required in first pass.

Design principle

The manifest is a helper, not a prison. TRURL should still scan folders without a manifest, and the manifest should improve labels, roles, and intent rather than impose a rigid layout.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions