documentação do sistema

This commit is contained in:
Luis Eduardo Estevao
2026-05-05 16:12:52 -03:00
parent bbb5d68af1
commit 4652fea8fc
41 changed files with 1919 additions and 0 deletions

34
AGENTS.md Normal file
View File

@@ -0,0 +1,34 @@
# AGENTS.md
## Dev environment tips
- Install dependencies with `npm install` before running scaffolds.
- Use `npm run dev` for the interactive TypeScript session that powers local experimentation.
- Run `npm run build` to refresh the CommonJS bundle in `dist/` before shipping changes.
- Store generated artefacts in `.context/` so reruns stay deterministic.
## Testing instructions
- Execute `npm run test` to run the Jest suite.
- Append `-- --watch` while iterating on a failing spec.
- Trigger `npm run build && npm run test` before opening a PR to mimic CI.
- Add or update tests alongside any generator or CLI changes.
## PR instructions
- Follow Conventional Commits (for example, `feat(scaffolding): add doc links`).
- Cross-link new scaffolds in `docs/README.md` and `agents/README.md` so future agents can find them.
- Attach sample CLI output or generated markdown when behaviour shifts.
- Confirm the built artefacts in `dist/` match the new source changes.
## Repository map
- `angular.json/` — explain what lives here and when agents should edit it.
- `browserslist/` — explain what lives here and when agents should edit it.
- `docker-compose.yml/` — explain what lives here and when agents should edit it.
- `Dockerfile/` — explain what lives here and when agents should edit it.
- `e2e/` — explain what lives here and when agents should edit it.
- `k8s/` — explain what lives here and when agents should edit it.
- `karma.conf.js/` — explain what lives here and when agents should edit it.
- `kendo-ui-license.txt/` — explain what lives here and when agents should edit it.
## AI Context References
- Documentation index: `.context/docs/README.md`
- Agent playbooks: `.context/agents/README.md`
- Contributor guide: `CONTRIBUTING.md`