|
1 | 1 | # Examples |
2 | 2 |
|
3 | | -## Documentation Services |
| 3 | +## Minimal Services |
| 4 | + |
| 5 | +??? example "Directory Interface Example" |
| 6 | + Here's the codebase interface directory implementation: |
| 7 | + |
| 8 | + ```txt |
| 9 | + ├── AGENTS.md # Documentation for AI agents that interact with this codebase |
| 10 | + ├── CONTRIBUTING.md # How to contribute to this codebase |
| 11 | + ├── PULL_REQUEST_TEMPLATE.md # Template for pull requests |
| 12 | + ├── README.md # Overview of this codebase for users |
| 13 | + ├── RUNBOOK.md # Operational documentation for operators |
| 14 | + ├── SUPPORT.md # Support guidelines for this codebase |
| 15 | + ├── Taskfile.yml # Taskfile for managing tasks |
| 16 | + ├── .gitattributes # Git attributes file |
| 17 | + ├── .gitignore # Git ignore file |
| 18 | + └── .editorconfig # Editor configuration file |
| 19 | + |
| 20 | + ``` |
| 21 | + |
| 22 | +## Open Source Documentation Services |
4 | 23 |
|
5 | 24 | - [Codebase Interface](https://github.com/codebase-interface/codebaseinterface){target="_blank"} |
6 | 25 |
|
|
26 | 45 | │ ├── README.md # Main documentation landing page |
27 | 46 | │ └── ... |
28 | 47 | ├── mkdocs.yml # MkDocs configuration file |
29 | | - ├── .editorconfig # Editor configuration file |
30 | 48 | ├── .gitattributes # Git attributes file |
31 | 49 | ├── .gitignore # Git ignore file |
32 | 50 | └── .editorconfig # Editor configuration file |
|
73 | 91 | │ ├── README.md # Introduction to outcomes |
74 | 92 | │ └── ... # UI implementation for outcomes such as reports, AI etc |
75 | 93 | ├── mkdocs.yml # MkDocs configuration file |
76 | | - ├── .editorconfig # Editor configuration file |
77 | 94 | ├── .gitattributes # Git attributes file |
78 | 95 | ├── .gitignore # Git ignore file |
79 | 96 | └── .editorconfig # Editor configuration file |
|
0 commit comments