Skip to content

Document DocumentServer superproject checkout requirement in AGENTS.md #6

Description

@moodyjmz

The @../AGENTS.md import in component-repo AGENTS.md files silently depends on each repo being checked out as a DocumentServer submodule. In the canonical superproject layout, ../ from sdkjs-forms/ resolves to DocumentServer/ — where AGENTS.md lives. A standalone clone produces no error; the import simply doesn't load.

The same layout invariant applies to the Grunt --addon path resolution: path.join('../../', 'sdkjs-forms') in sdkjs/build/Gruntfile.js expects sdkjs-forms to be a sibling of sdkjs in the workspace — which is only guaranteed in the DocumentServer superproject checkout.

Neither the current AGENTS.md nor the proposed replacement documents this requirement. An agent (or contributor) cloning sdkjs-forms standalone gets silently degraded tooling with no indication why.

What needs doing

Add a brief Checkout section to AGENTS.md (and to web-apps/AGENTS.md when that lands) stating:

  • This repo is a DocumentServer submodule — always clone via the superproject (git submodule update --init --recursive).
  • Standalone clones will not resolve @../AGENTS.md (the shared AI policy and build guide at DocumentServer/AGENTS.md).
  • The grunt --addon=sdkjs-forms path resolution also requires this layout.

Discovered during review of #5.

Metadata

Metadata

Assignees

Labels

choredocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions