Skip to content

armgit / macro

Public Imported from GitHub
0

Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.

2.9 KB
Raw Blame

For Mintlify product knowledge (components, configuration, writing standards), install the Mintlify skill: npx skills add https://mintlify.com/docs

Documentation project instructions

What it is

The customer-facing documentation site for Macro, served at docs.macro.com and built on Mintlify. It covers the hosted product for end users, plus the MCP tool reference pages AI surfaces expose.

About this project

  • Pages are MDX files with YAML frontmatter
  • Configuration lives in docs.json
  • Run mint dev to preview locally
  • Run mint broken-links to check links
  • Brand styling matches macro.com: colors and self-hosted fonts (fonts/) are set in docs.json, and style.css overrides Mintlify defaults Mintlify config can't reach
  • MCP tool reference pages under AI/mcp/tools/ are generated by scripts/generate-mcp-tool-pages.ts from the current MCP registry (gen_tool_schemas --mcp) in crates/ai_tools; historical frontend schemas must not feed public documentation — fix the generator or schemas, not the output

Terminology

  • Call a form’s conditional answer check a gate in UI copy, AI tools, and docs.
  • Block is a proper noun for a core unit in Macro (a doc, email, channel, task, call, canvas, and so on). Capitalize it every time: "the Agents Block", "Block types". Use "Block", not "module" or "app". Leave ordinary English alone: code block, blockquote, and Block Sender
  • Use @mention (not "at-mention" or "tag") for references created with @
  • Use channel (not "chat room"), agent (not "bot"), and workspace for a user's whole Macro environment
  • Use personal memory and team memory for the two memory levels
  • Signal and Noise are capitalized when referring to the inbox and email views
  • Third-party products use their official capitalization: GitHub, Gmail, Notion, Slack

Style preferences

  • Use active voice and second person ("you")
  • Keep sentences concise — one idea per sentence
  • Use sentence case for headings
  • Bold for UI elements: Click Settings
  • Code formatting for file names, commands, paths, and code references
  • Keyboard shortcuts use <kbd> tags, e.g. press g + h
  • Block tutorial videos embed from https://macro.com/video/tutorials/<id>.mp4 (with <id>-poster.jpg), the copy the website publishes from apps/marketing/public/video/tutorials/; don't commit them here
  • Product UI in the guides uses the same light cards as Unified Tagging (.search-preview and .tag-mock in style.css). Diagrams and brand graphics stay in images/ and need descriptive alt text — never the filename

Content boundaries

  • Document the hosted product; self-hosting is covered only at a high level in the FAQ
  • Don't document internal tooling, infrastructure details, or unreleased features
  • Don't add placeholder or "WIP" pages — add a page only when there's real content for it