add SKILL
This commit is contained in:
36
DOCS.md
36
DOCS.md
@@ -6,7 +6,7 @@ Technical index for developers and AI agents. Use this as the entry point to all
|
||||
|
||||
## Documentation Languages
|
||||
- Technical docs: English (`docs/` and subfolders).
|
||||
- Repository summary: `README.md` (Russian).
|
||||
- Repository summary: `README.md` (English).
|
||||
New documents should be added in English unless noted.
|
||||
|
||||
---
|
||||
@@ -45,11 +45,45 @@ Technical index for developers and AI agents. Use this as the entry point to all
|
||||
- `docs/backend/security.md` — authN/Z, secret handling, webhook verification, audit/event logging.
|
||||
- `docs/backend/payment-flow.md` — payment integration (provider-agnostic template; single source of truth for payment flows and webhooks).
|
||||
|
||||
### 4) Examples (`/docs/examples`)
|
||||
- `docs/examples/RECOMMENDATIONS-example.md` — filled-in example of `RECOMMENDATIONS.md` for a compliance classifier (Archetype C).
|
||||
|
||||
---
|
||||
|
||||
## Root-Level Files
|
||||
|
||||
- `README.md` — project overview and quick start.
|
||||
- `RULES.md` — core repository rules for AI agents.
|
||||
- `RECOMMENDATIONS.md` — project-specific decisions and overrides (template).
|
||||
- `CONTRIBUTING.md` — commit conventions, PR rules, how to add docs/agents/ADRs.
|
||||
- `SECURITY.md` — vulnerability disclosure policy.
|
||||
- `package.json` — project metadata and Node.js engine requirement.
|
||||
- `.env.example` — environment variables template.
|
||||
- `.editorconfig` — editor formatting standards (indentation, line endings).
|
||||
|
||||
## Agent Profiles (`/agents`)
|
||||
|
||||
- `agents/README.md` — agent index, selection guide, and shared context7 guidelines.
|
||||
- `agents/frontend-architect.md` — frontend specialist (React, Next.js, accessibility, performance).
|
||||
- `agents/backend-architect.md` — backend specialist (system design, databases, APIs).
|
||||
- `agents/security-auditor.md` — security review (OWASP, auth, vulnerability assessment).
|
||||
- `agents/test-engineer.md` — testing specialist (strategy, automation, CI/CD).
|
||||
- `agents/code-reviewer.md` — code quality and PR review.
|
||||
- `agents/prompt-engineer.md` — LLM prompt design and optimization.
|
||||
|
||||
## GitHub Templates (`/.github`)
|
||||
|
||||
- `.github/ISSUE_TEMPLATE/bug_report.md` — bug report template.
|
||||
- `.github/ISSUE_TEMPLATE/feature_request.md` — feature request template.
|
||||
- `.github/ISSUE_TEMPLATE/config.yml` — issue template configuration.
|
||||
- `.github/PULL_REQUEST_TEMPLATE.md` — PR description template.
|
||||
|
||||
---
|
||||
|
||||
## How to Use This Index
|
||||
- **New to the project:** read `project-overview.md` and `phases-plan.md` first.
|
||||
- **Designing features:** use frontend/backend architecture docs plus API/security/payment flow specs.
|
||||
- **Expanding docs:** add new English `*.md` files under `docs/` and update this index with links.
|
||||
- **Contributing:** read `CONTRIBUTING.md` for commit conventions and PR rules.
|
||||
|
||||
**Last Updated:** Phase 0 (Planning)
|
||||
|
||||
Reference in New Issue
Block a user