Lifecycle documents
Use primary documents for shared Initiative, Feature, and Issue narrative while keeping structured data in controls.
Primary documents are shared rich-text pages attached to Initiatives, Features, and Issues. They are useful when the team needs durable narrative that is longer than a summary field but still belongs with the object.
Supported objects
| Object | Where to use it |
|---|---|
| Initiative | Initiative description, background, risks, dependencies, and delivery notes. |
| Feature | Feature description, acceptance context, implementation notes, and review framing. |
| Issue | Work-item description, implementation context, and supporting narrative. |
Integrity creates one primary document per supported object. Separate supporting Documents are exposed through the object's Resources row and have their own title and nested route.
Repository lifecycle packet documents
Repository lifecycle workflows use a separate four-file evidence packet:
spec.mdplan.mdtasks.mdbuild-notes.md
When a lifecycle command synchronizes that packet, Integrity stores the exact current Markdown, content hash, version, and repository source path. These records are not the Feature's primary document, supporting Documents, Health updates, comments, or local working-tree files.
An authenticated coding agent can use
integrity.lifecycle.get_packet_document to read one stored packet document at
a time. The tool returns the exact stored Markdown without parsing, repairing,
summarizing, or silently truncating it. Reading all four documents requires four
explicit calls. A missing document returns a content-free unavailable result;
an older record above the supported response bound returns safe metadata but no
partial body.
The read follows the caller's current Feature access and repository/workspace scope and grants no edit, synchronization, approval, or lifecycle-transition authority. Repository changes still happen in the local working tree and use the normal reviewed lifecycle synchronization workflow before Integrity's stored copy changes.
Use the primary document for shared product narrative. Use the repository packet for synchronized implementation evidence. Reading one never substitutes for or updates the other.
What stays structured
Do not use the document as a replacement for structured fields. Keep these in their existing controls:
- Feature, Initiative, and Issue status, priority, owner/lead/assignee, members, and Teams
- roadmap dates, Initiative membership, Feature dependencies, and Issue links
- Health updates, comments, Activity, and Inbox notifications
- Source Library requirements, artefacts, trace links, baselines, reviews, and approvals
Integrity does not parse document text to change planning state. If a value affects filtering, rollups, permissions, reviews, or release evidence, use the relevant field or workflow.
Collaboration and access
The document follows the visibility of the object it belongs to. People with read access can view the document. People with edit access can type, apply approved agent suggestions, and persist snapshots.
Live collaboration uses private realtime channels. Payloads do not include document body text, Markdown, Tiptap JSON, or Yjs state. Clients refetch through normal permission checks for durable content.
Search, export, and references
Integrity stores projections for plain text and Markdown so search, export, and agent context can use stable snapshots. Restricted or unavailable references are rendered as display-safe text. Hidden references are omitted from projections.
Navigate long documents
Use headings to structure longer documents. Type /toc and choose Table of
contents to insert a linked outline at the current cursor position. The table
of contents is part of the shared document, so every viewer sees it in the same
place. Editors can move or remove it like other document components.
The component updates as headings change. Select an outline item to move to that heading; the heading link is also stored in the page URL so you can copy a deep link to that section. Search, Markdown exports, and agent context keep the document headings and body without duplicating outline text.
Retired Teamspace notes
Legacy Teamspace notes, folders, shares, access requests, note images, Hocuspocus collaboration, and note-specific editor commands are retired from active product paths. Historical references are retained through read-only or tombstone behavior where needed, but new narrative authoring should happen on Initiatives, Features, and Issues.
Related
Documents & Resources
Use supporting Documents, links, private attachments, and editor media.
Agent document edits
Review and apply suggestions without silent mutations.
Health updates
Structured authored health reports for Features and Initiatives.
Drafts & proposals
Reviewable lifecycle evidence changes.