docs: align with satware AG best practices
- Delete deprecated CLAUDE.md - Create root-level AGENTS.md for AI assistant guidance - Create SDD constitution in .specify/memory/constitution.md - Align documentation with PARA structure (docs/product/project-brief.md, docs/tech/stack.md, docs/plans/) - Add standardized YAML frontmatter to all documentation files - Update README.md with saTway branding and structure
This commit is contained in:
@@ -0,0 +1,32 @@
|
||||
# AGENTS.md (mw-pfeddersheim-workstation)
|
||||
|
||||
## Project Overview
|
||||
This repository manages the infrastructure, configuration, and maintenance for Michael Wegener's primary workstation at satware AG (Pfeddersheim location). It uses Ansible for system configuration and shell scripts for maintenance.
|
||||
|
||||
## Key Directories
|
||||
- `ansible/`: Configuration-as-Code via Ansible roles and playbooks.
|
||||
- `docs/`: PARA-structured documentation (Product, ADR, Learnings, Tech).
|
||||
- `scripts/`: Automation and maintenance scripts.
|
||||
- `config/`: Templates for system configuration files.
|
||||
|
||||
## Essential Commands
|
||||
| Task | Command |
|
||||
|------|---------|
|
||||
| Apply Configuration | `ansible-playbook ansible/workstation.yml` |
|
||||
| System Maintenance | `bash scripts/maintenance.sh` |
|
||||
| Verify Ansible | `ansible-playbook ansible/workstation.yml --check` |
|
||||
|
||||
## Standards
|
||||
- **Baby Steps™**: Small, verifiable changes (<200 LOC per commit).
|
||||
- **PARA Documentation**: Keep documentation updated in the `docs/` folder.
|
||||
- **Zero-Trust**: Secrets must be handled via Ansible Vault or environment variables.
|
||||
|
||||
## Guardrails
|
||||
- **NEVER** commit raw secrets to the repository.
|
||||
- **ALWAYS** run Ansible with `--check` before applying changes.
|
||||
- **NEVER** modify system configuration directly if it can be managed via Ansible.
|
||||
|
||||
## Rules Hierarchy
|
||||
- Global rules: `Rules/`
|
||||
- Project rules: `.clinerules/`
|
||||
- Agent instructions: `AGENTS.md` (this file)
|
||||
Reference in New Issue
Block a user