43 lines
1.6 KiB
Markdown
43 lines
1.6 KiB
Markdown
# Documentation Index
|
|
|
|
Welcome to the repository knowledge base. Start with the project overview, then dive into specific guides as needed.
|
|
|
|
## Core Guides
|
|
- [Project Overview](./project-overview.md)
|
|
- [Architecture Notes](./architecture.md)
|
|
- [Development Workflow](./development-workflow.md)
|
|
- [Testing Strategy](./testing-strategy.md)
|
|
- [Glossary & Domain Concepts](./glossary.md)
|
|
- [Security & Compliance Notes](./security.md)
|
|
- [Tooling & Productivity Guide](./tooling.md)
|
|
|
|
## Repository Snapshot
|
|
- `angular.json/`
|
|
- `browserslist/`
|
|
- `docker-compose.yml/`
|
|
- `Dockerfile/`
|
|
- `e2e/`
|
|
- `k8s/`
|
|
- `karma.conf.js/`
|
|
- `kendo-ui-license.txt/`
|
|
- `nginx.conf/`
|
|
- `package-lock.json/`
|
|
- `package.json/`
|
|
- `README.md/`
|
|
- `src/` — TypeScript source files and CLI entrypoints.
|
|
- `tsconfig.app.json/`
|
|
- `tsconfig.json/`
|
|
- `tsconfig.spec.json/`
|
|
- `tslint.json/`
|
|
|
|
## Document Map
|
|
| Guide | File | Primary Inputs |
|
|
| --- | --- | --- |
|
|
| Project Overview | `project-overview.md` | Roadmap, README, stakeholder notes |
|
|
| Architecture Notes | `architecture.md` | ADRs, service boundaries, dependency graphs |
|
|
| Development Workflow | `development-workflow.md` | Branching rules, CI config, contributing guide |
|
|
| Testing Strategy | `testing-strategy.md` | Test configs, CI gates, known flaky suites |
|
|
| Glossary & Domain Concepts | `glossary.md` | Business terminology, user personas, domain rules |
|
|
| Security & Compliance Notes | `security.md` | Auth model, secrets management, compliance requirements |
|
|
| Tooling & Productivity Guide | `tooling.md` | CLI scripts, IDE configs, automation workflows |
|