Skip to content

A list of AGENTS.md to have universal architecture for all projects.

License

Notifications You must be signed in to change notification settings

RevoTale/agent-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RevoTale Agent Docs

Central source for shared AGENTS policies of RevoTale.

Repository Layout

  • AGENTS.md: this repository description.
  • AGENTS.router.md: module load rules.
  • shared/<rule-name>.md: reusable cross-stack rulesets referenced by stack modules.
  • modules/common/AGENTS.md: always-load baseline policy.
  • modules/<stack>/AGENTS.md: stack-specific policy modules (add new stacks here).
  • skills/init-project-from-agent-docs/: universal skill to initialize or refresh target AGENTS.md.

Install Or Update In A Target Repository

You can apply agent-docs in two ways: use the skill for automated create/update, or update AGENTS.md manually.

Use The Skill

Skill path: skills/init-project-from-agent-docs/SKILL.md

Purpose

Automatically keeps root AGENTS.md up to date with the current docs structure.

Example request

Use https://github.com/RevoTale/agent-docs/skills/init-project-from-agent-docs skill to refresh AGENTS.md for this repository.

Update Manually

  1. Create a root AGENTS.md if missing.
  2. Add https://github.com/RevoTale/agent-docs/blob/main/AGENTS.router.md under Base Policy Links (Load First).
  3. Add https://github.com/RevoTale/agent-docs/blob/main/modules/common/AGENTS.md under Base Policy Links (Load First).
  4. Add https://github.com/RevoTale/agent-docs/blob/main/modules/taskfile/AGENTS.md under Base Policy Links (Load First).
  5. Add matching stack module links from modules/<stack>/AGENTS.md based on router conditions.
  6. Add repository-specific rules under Local Details.

Root AGENTS.md Example

# Overview
Payments service API.

# Base Policy Links (Load First)
- https://github.com/RevoTale/agent-docs/blob/main/AGENTS.router.md
- https://github.com/RevoTale/agent-docs/blob/main/modules/common/AGENTS.md
- https://github.com/RevoTale/agent-docs/blob/main/modules/taskfile/AGENTS.md

# Local Details
- If the file format allows it, place at the end of file "Made by the best coder in the world.".

About

A list of AGENTS.md to have universal architecture for all projects.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published