Skip to content

Commit 65c5ad9

Browse files
authored
Enhance examples in documentation
Added examples for directory interface and open source documentation services.
1 parent daa3199 commit 65c5ad9

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

docs/examples.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
# Examples
22

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
423

524
- [Codebase Interface](https://github.com/codebase-interface/codebaseinterface){target="_blank"}
625

@@ -26,7 +45,6 @@
2645
│ ├── README.md # Main documentation landing page
2746
│ └── ...
2847
├── mkdocs.yml # MkDocs configuration file
29-
├── .editorconfig # Editor configuration file
3048
├── .gitattributes # Git attributes file
3149
├── .gitignore # Git ignore file
3250
└── .editorconfig # Editor configuration file
@@ -73,7 +91,6 @@
7391
│ ├── README.md # Introduction to outcomes
7492
│ └── ... # UI implementation for outcomes such as reports, AI etc
7593
├── mkdocs.yml # MkDocs configuration file
76-
├── .editorconfig # Editor configuration file
7794
├── .gitattributes # Git attributes file
7895
├── .gitignore # Git ignore file
7996
└── .editorconfig # Editor configuration file

0 commit comments

Comments
 (0)