Skip to content

[Docs] Update project documentation in dedicated documentation repository #18

Open

Description

@javiercavlop

Overview

Update and synchronize project documentation in the dedicated documentation repository to accurately reflect recent architectural changes, schema evolution, and platform capabilities.

Objectives & Scope

  • Audit existing documentation against the current platform implementation and identify stale or missing sections.
  • Document the updated BIM specifications, engine protocols, and workflow constructs.
  • Update API references, request/response examples, and developer onboarding instructions.
  • Ensure deployment guides and local development instructions align with latest service configurations.

Acceptance Criteria

  • Documentation repository reflects all current platform architecture components and service interactions.
  • BIM specification guides include updated syntax, loop handling, and constraint examples.
  • API endpoint reference documents all current route signatures and parameters.
  • Setup and deployment documentation verified against clean local installations.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions