Revert "optimize(doc): add resources/templates/README.md.tpl + DEPLOY.md.tpl + reference (d6 target)"

This reverts commit b26a94d779.
This commit is contained in:
bastien 2026-05-06 18:32:54 +02:00
parent ae49ca99a8
commit 69348d0463
3 changed files with 0 additions and 97 deletions

View File

@ -31,19 +31,6 @@ allowed-tools:
Load and follow strictly: Load and follow strictly:
- $HOME/.claude/agents/doc-syncer.md - $HOME/.claude/agents/doc-syncer.md
## Resources
The agent uses these reusable templates instead of inlining markdown each time:
- `resources/templates/README.md.tpl` — GitHub-style README skeleton (title, quick start, sub-doc links, stack, license).
- `resources/templates/DEPLOY.md.tpl` — Deploy doc skeleton (prereqs, build, deploy, verify, rollback, common failures).
When the agent decides a doc must be created (STEP 5 / STEP 6 in the agent flow),
read the matching template, substitute `{{PLACEHOLDERS}}` from project state
(stack detection, manifest, env signals), and write to project root. Do not
copy the placeholders verbatim — every `{{...}}` must be replaced or removed
before writing.
Execute the DOC SYNCER on this project. Execute the DOC SYNCER on this project.
Context from the user (if any): Context from the user (if any):

View File

@ -1,49 +0,0 @@
# Deploy
Stack: {{STACK}}
Target: {{DEPLOY_TARGET}}<!-- e.g. Vercel, fly.io, Docker on VPS, k8s -->
## Prerequisites
- {{REQUIRED_TOOLS}}<!-- gh, fly, docker, kubectl, etc. -->
- Environment variables set in {{ENV_LOCATION}}<!-- .env / Vercel dashboard / GH secrets -->
## Build
```bash
{{BUILD_CMD}}
```
Verify the build artifact at `{{BUILD_OUTPUT_DIR}}` is non-empty before proceeding.
## Deploy
```bash
{{DEPLOY_CMD}}
```
## Verify
```bash
{{HEALTH_CHECK_CMD}}<!-- curl /healthz or equivalent -->
```
Expected response: `{{EXPECTED_RESPONSE}}`.
## Rollback
```bash
{{ROLLBACK_CMD}}<!-- e.g. fly releases rollback <id>, kubectl rollout undo, vercel rollback -->
```
## Common failures
| Symptom | Cause | Fix |
|---|---|---|
| {{SYMPTOM_1}} | {{CAUSE_1}} | {{FIX_1}} |
| Build fails on `{{COMMON_BUILD_ERR}}` | Likely env var missing | Check {{ENV_LOCATION}} has {{REQUIRED_VARS}} |
## Logs / monitoring
- Logs: `{{LOG_CMD}}`
- Monitoring: {{MONITORING_URL}}<!-- Grafana / Sentry / Vercel analytics -->

View File

@ -1,35 +0,0 @@
# {{PROJECT_NAME}}
> {{ONE_LINE_DESCRIPTION}}
{{BADGES}}<!-- e.g. build status, license, version -->
## Quick start
```bash
{{INSTALL_CMD}}
{{BUILD_CMD}}
{{RUN_CMD}}
```
## What's inside
{{ONE_PARAGRAPH_OVERVIEW}}
## Documentation
{{DOC_INDEX}}<!-- bullet list of links to existing sub-docs -->
- [Install](INSTALL.md){{IF_INSTALL}}
- [Configure](CONFIGURE.md){{IF_CONFIGURE}}
- [Usage](USAGE.md){{IF_USAGE}}
- [Deploy](DEPLOY.md){{IF_DEPLOY}}
- [Contributing](CONTRIBUTING.md){{IF_CONTRIBUTING}}
- [Changelog](CHANGELOG.md){{IF_CHANGELOG}}
## Stack
{{STACK_BULLETS}}<!-- one bullet per language/framework with version -->
## License
{{LICENSE}}