Skip to main content

Docs agent guide (/docs)

This directory is the source of truth for documentation content.

  • Source: /docs/** (edit here)
  • Site build copy: /apps/docs/docs/** (generated/synced during docs site build)
  • Published at: https://grida.co/docs

Actively maintained

We only actively maintain the following docs areas:

  • docs/wg/** — working group docs (design notes, architecture, proposals, WIP)
  • docs/reference/** — reference docs (glossary, specs, stable technical references)

Everything else

Other folders under /docs are not actively managed.

  • Unless you have a specific task, avoid editing content outside docs/wg/** and docs/reference/**.
  • Do not edit generated artifacts under /apps/docs/docs/**.

Structure

directorynamedescriptionactive
/docs/wgworking groupworking group documents, architecture documents, todo list, etcyes
/docs/referencereferenceglossary and references (technical documents)yes
/docs/mathmathMath reference, used for internal docs referencingyes
/docs/platformplatformGrida Platform (API/Spec) documentsyes
/docs/editoreditorGrida Editor - User Documentationyes
/docs/canvascanvasGrida Canvas SDK - User Documentationno
/docs/clicliGrida CLI - User Documentationyes
/docs/togethertogetherContributing, Support, Community, etcyes
/docs/with-figmawith-figmaGrida with Figma - Grida <-> Figma compatibility and user guidesyes