harald/zeroclaw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3
zeroclaw/docs/doc-template.md
Chummy ce104bed45 feat(proxy): add scoped proxy configuration and docs runbooks 
- add scope-aware proxy schema and runtime wiring for providers/channels/tools

- add agent callable proxy_config tool for fast proxy setup

- standardize docs system with index, template, and playbooks
2026-02-18 22:10:42 +08:00

1.3 KiB
Raw Blame History

Documentation Template (Operational)

Use this template when adding a new operational or engineering document under docs/.

Keep sections that apply; remove non-applicable placeholders before merging.

1. Summary

  • Purpose:
  • Audience: <operators | reviewers | contributors | maintainers>
  • Scope:
  • Non-goals:

2. Prerequisites

  • <required tools/config>

3. Procedure

3.1 Baseline Check

3.2 Main Workflow

3.3 Verification

  • <validation command/log/checkpoint>

4. Safety, Risk, and Rollback

  • Risk surface:
  • Failure modes:
  • Rollback plan: <concrete rollback command/steps>

5. Troubleshooting

  • Symptom: <error/signal>
    • Cause:
    • Fix:

6. Related Docs

  • README.md — documentation taxonomy and navigation.
  • <related-doc-1.md>
  • <related-doc-2.md>

7. Maintenance Notes

  • Owner: <team/persona/area>
  • Update trigger:
  • Last reviewed: