Skip to main content

Create and structure docs

Docs is the long-form wiki for workspace context. Use this guide to create pages that people and AI can find, cite, and maintain.

Create a doc

  1. Check the project picker.
    • Use All Projects for organisation-wide context.
    • Use a project scope for project-specific docs.
  2. Open Docs.
  3. Select the Create doc button in the docs sidebar.
  4. Enter a clear title.
  5. Start writing in the body editor.
  6. Wait for the saved indicator after meaningful edits.

Use direct titles such as Enterprise onboarding checklist or Billing architecture constraints. Avoid vague titles such as Notes.

Create a child page

  1. Open the parent page.
  2. Use the doc tree context menu or the editor's child-page insertion flow.
  3. Create the child page.
  4. Give it a specific title.
  5. Add a short summary at the top.
  6. Return to the parent and confirm the child page appears in the expected place.

Use child pages for research, implementation notes, customer context, follow-up plans, and supporting material under a stable parent.

Structure a page

  1. Start with a one-paragraph summary.
  2. Use headings for major sections.
  3. Use bullets for constraints, decisions, risks, and next steps.
  4. Add references to related tickets, decisions, risks, memory, snapshots, or docs.
  5. Split the page when separate topics begin competing for attention.

Good docs are readable to a teammate who did not attend the meeting or write the plan.

Add references

  1. Copy the visible display ID of the related record.
  2. Paste it into the doc body where the dependency matters.
  3. Use the reference in a sentence, not only as a loose link.
  4. Save the doc.
  5. Open details or backlinks later to verify the relationship.

Example:

This rollout depends on DEC-18 and resolves the customer risk tracked in RISK-7.
Implementation work is tracked in APP-42.

Organize the docs tree

  1. Use top-level pages for stable areas such as product, customers, engineering, operations, or policies.
  2. Nest child pages under the page that owns the context.
  3. Drag pages in the tree to reorder or reparent them.
  4. Create an index page when a section has many child pages.
  5. Search before creating another similar page.

If a doc seems missing, switch between All Projects and the relevant project before assuming it was deleted.

Duplicate a doc

  1. Open the doc.
  2. Open the doc actions menu.
  3. Select Duplicate.
  4. Rename the duplicate.
  5. Edit content that should not carry over.
  6. Confirm references still point to the right records.

Duplicate only when the old structure is a useful template. Do not duplicate stale facts into new pages without reviewing them.

Extract memory from a doc

  1. Finish and review the source doc.
  2. Open the doc actions menu.
  3. Select Extract memory.
  4. Wait for Agent running to finish.
  5. Open Inbox or Memory Diffs.
  6. Review each proposed fact.
  7. Accept only facts that are accurate, durable, scoped correctly, and useful.
  8. Reject speculative, stale, or overly broad facts.
Memory extraction

Extract memory creates proposals. It does not automatically turn the whole doc into trusted memory.

Restore an earlier revision

  1. Open the doc.
  2. Open the details or revision panel.
  3. Review the available revisions.
  4. Choose the revision to restore.
  5. Confirm the restored body is correct.
  6. Extract memory again only if the restored content contains durable facts that should change active memory.

Archive a stale doc

  1. Open the doc.
  2. Review backlinks and related memory.
  3. Open the doc actions menu.
  4. Select Archive.
  5. Confirm active search and docs lists no longer treat the page as current.

Archive is the default retirement path. It preserves history while reducing stale guidance.

Delete a doc

  1. Open the doc.
  2. Review child docs, backlinks, and related memory.
  3. Open the doc actions menu.
  4. Select Delete.
  5. Choose whether nested child docs should be deleted or kept.
  6. Choose whether memory extracted from the deleted docs should be archived.
  7. Confirm deletion.

Use delete only when the page should be removed from docs, revisions, backlinks, and search.

Related concepts: Docs wiki, Memory diffs, Search and references.