-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Objective
Define the identity of SYNER.md and AGENTS.md files, and document syner.md for all audiences (agents, developers, end users).
Context
The Syner ecosystem follows a file/domain synergy pattern:
CLAUDE.md↔claude.aiSYNER.md↔syner.md
This epic establishes the spec for these files and creates documentation for syner.md.
Scope
In Scope
- SYNER.md spec: What it is, what it contains, where it lives
- AGENTS.md spec: How agents consume syner.md via MCP
- Documentation in syner.dev about syner.md capabilities
- Landing/docs in syner.md explaining the product
Out of Scope
- Documentation for syner.bot
- Documentation for syner.app
SYNER.md Spec
Questions to answer:
- What is SYNER.md? (ecosystem vision, identity file)
- Where does it live? (monorepo root? served via syner.md?)
- What does it contain? (primitives, core concepts, structure)
- How is it consumed? (by agents, by humans, by other files)
Potential structure:
syner.md/syner/ecosystem → SYNER.md (ecosystem vision)
syner.md/syner/md → SYNER.md for syner.md product
syner.md/syner/bot → SYNER.md for syner.bot product
AGENTS.md Spec
Define how agents interact with syner.md:
- MCP tools available
- How to read files
- How to query registry
- Authentication requirements
Documentation Structure
syner.dev
- Section: "syner.md capabilities"
- API reference for reading/writing md files
- MCP server documentation
syner.md (apps/md/)
- Landing page explaining the product
- "What is syner.md?"
- "How to publish your markdown"
- "Using syner.md with agents"
Deliverables
- SYNER.md spec document
- AGENTS.md spec for syner.md
- syner.dev section: "syner.md capabilities"
- Basic landing/docs in apps/md/
Dependencies
- Epic Epic: GitHub App Integration #35 (GitHub App Integration)
- Epic Epic: syner.md Core #36 (syner.md Core)
Labels
epic, documentation, spec
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels