Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 3.83 KB

README.md

File metadata and controls

43 lines (33 loc) · 3.83 KB

Docs

Reference material for topics that span more than one workspace. Each file below says what it covers; anything owned by a single app or package is documented in that workspace instead.

Cross-workspace topics

  • architecture.md: how the workspaces depend on each other and how content gets from content/** to the site
  • deployment.md: branches, CI and what deploys where
  • components.md: shared UI components, their props and their Figma nodes
  • funnel/README.md: the funnel forms, from apps/web through apps/api to Notion
  • media-migration.md: the redirect map for moving blog.logos.co to logos.co/media
  • oss-scanner.md: the offline OSS Scanner image and what it builds and leaves out
  • zines.md: the /zines catalogue and reader, from content/zines/** and the print PDFs to the generated page assets

Workspaces

Workspace README Deeper docs
apps/web README docs
apps/cms README docs
apps/api README architecture
apps/logos-crm README docs
apps/logos-demos README docs
apps/past-present-future README
packages/content README AGENTS
packages/funnel README AGENTS
packages/ui README
packages/tokens README
packages/types README
packages/config README
e2e README AGENTS

Writing docs

READMEs are for people: what the thing is, how to run it, where to go next. AGENTS.md files hold rules for coding agents. Reference material goes in a docs/ folder, in the narrowest workspace that owns all the code it describes, and root docs/ is only for topics that span workspaces. Start each doc with a # Title and one sentence of scope that links the code it covers, and update it in the same PR as the behaviour change. The full rules are in the Documentation section of the root AGENTS.md.

AI tooling

Agent context comes only from AGENTS.md files, the root one plus one per workspace where needed. There is no CLAUDE.md. A few tool limits worth knowing:

  • Claude Code below v2.1.277 reads no AGENTS.md.
  • A personal CLAUDE.local.md turns AGENTS.md off for you; set instructionFiles: claude-md-and-agents-md in ~/.claude/settings.json to fix it.
  • VS Code Copilot reads nested AGENTS.md files only when chat.useNestedAgentsMdFiles is on.