Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 2.07 KB

AGENTS.md

File metadata and controls

30 lines (21 loc) · 2.07 KB

PowerSync Docs — Agent Orientation

PowerSync keeps backend databases in sync with in-app SQLite databases. Apps read and write locally, so they respond instantly and work without a network connection. This repository contains the Mintlify documentation site, written in MDX.

Required Reading

Before creating, revising, or reviewing documentation, read .claude/CLAUDE.md in full. It is the canonical source for shared workflows and writing standards, including Style Authority and Plain Technical English.

Skills, reviewer prompts, and generic Mintlify guidance do not override those standards. Maintain shared rules in the canonical file and link to them from task instructions.

Task Entry Points

Task Instructions
Write or revise docs .claude/skills/doc-author/SKILL.md
Document a PR or spec .claude/skills/pr-to-docs/SKILL.md
Read external documentation .claude/skills/doc-reader/SKILL.md
Use Mintlify components or configuration .agents/skills/mintlify/SKILL.md
Review docs .claude/agents/document-reviewer.md or /review-docs
Run documentation checks /lint-docs
Maintain scheduled cloud routines routines/README.md

Repository Map

  • docs.json: navigation, theme, and redirects. Read before changing documentation.
  • *.mdx: pages; snippets/: reusable components; images/ and logo/: assets.
  • .vale.ini and .github/vale/: prose lint rules and accepted vocabulary.
  • routines/: versioned copies of cloud prompts; editing these files does not update a live routine.

For the published documentation index, fetch llms.txt before exploring the live site. For repository work, search the local files first.