Skip to content

Commit f11fa28

Browse files
committed
docs: expand examples for source aligned services, detailing directory structure and documentation files
1 parent cd0b007 commit f11fa28

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

docs/examples.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,47 @@
3535

3636
## Source Aligned Services
3737

38-
TODO: Add examples of source aligned services that follow the codebase interface principles.
38+
```txt
39+
├── AGENTS.md # Documentation for AI agents that interact with this codebase
40+
├── CHANGELOG.md # Documentation of notable changes
41+
├── CODE_OF_CONDUCT.md # Code of conduct for contributors
42+
├── CONTRIBUTING.md # How to contribute to this codebase
43+
├── LANGUAGE.md # Ubiquitous language for this codebase
44+
├── LICENSE.md # License for this codebase
45+
├── PULL_REQUEST_TEMPLATE.md # Template for pull requests
46+
├── README.md # Overview of this codebase for users
47+
├── RUNBOOK.md # Operational documentation for operators
48+
├── SECURITY.md # Security policy for this codebase
49+
├── SUPPORT.md # Support guidelines for this codebase
50+
├── TODO.md # List of tasks to be completed
51+
├── Taskfile.yml # Taskfile for managing tasks
52+
├── cliff.toml # Configuration file for the Cliff tool
53+
├── docs # Documentation directory
54+
│ ├── README.md # Main documentation landing page
55+
│ └── ...
56+
├── design # Design directory
57+
│ ├── README.md # Introduction to design
58+
│ ├── contracts # Any Open API, AsyncAPI, data contracts etc
59+
│ └── decisions # Architectural decision records localised to the service
60+
├── behaviour # Behaviour directory
61+
│ ├── README.md # Introduction to behaviour
62+
│ └── ... # Behaviour implementation encapsulating business logic
63+
├── experiences # Experiences directory
64+
│ ├── README.md # Introduction to experiences
65+
│ └── ... # UI implementation for behaviour such as web, app, AI etc
66+
├── publication # Publication directory
67+
│ ├── README.md # Introduction to publication
68+
│ └── ... # Implementation of data publications
69+
├── outcomes # Outcomes directory
70+
│ ├── README.md # Introduction to outcomes
71+
│ └── ... # UI implementation for outcomes such as reports, AI etc
72+
├── mkdocs.yml # MkDocs configuration file
73+
├── .editorconfig # Editor configuration file
74+
├── .gitattributes # Git attributes file
75+
├── .gitignore # Git ignore file
76+
└── .editorconfig # Editor configuration file
77+
78+
```
3979

4080
[← Previous: Tooling](../){ .md-button }
4181
[Next: Welcome →](../){ .md-button .md-button--primary style="float: right;" }

0 commit comments

Comments
 (0)