Skip to content

Commit 12b3e29

Browse files
author
committed
Deployed 30aa21e with MkDocs version: 1.6.1
1 parent d8a8bbe commit 12b3e29

File tree

3 files changed

+44
-44
lines changed

3 files changed

+44
-44
lines changed

‎CNAME‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎examples/index.html‎

Lines changed: 43 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -671,48 +671,49 @@ <h2 id="documentation-services">Documentation Services<a class="headerlink" href
671671
</code></pre></div>
672672
</details>
673673
<h2 id="source-aligned-services">Source Aligned Services<a class="headerlink" href="#source-aligned-services" title="Permanent link">&para;</a></h2>
674-
<div class="highlight"><pre><span></span><code>```txt
675-
├── AGENTS.md # Documentation for AI agents that interact with this codebase
676-
├── CHANGELOG.md # Documentation of notable changes
677-
├── CODE_OF_CONDUCT.md # Code of conduct for contributors
678-
├── CONTRIBUTING.md # How to contribute to this codebase
679-
├── LANGUAGE.md # Ubiquitous language for this codebase
680-
├── LICENSE.md # License for this codebase
681-
├── PULL_REQUEST_TEMPLATE.md # Template for pull requests
682-
├── README.md # Overview of this codebase for users
683-
├── RUNBOOK.md # Operational documentation for operators
684-
├── SECURITY.md # Security policy for this codebase
685-
├── SUPPORT.md # Support guidelines for this codebase
686-
├── TODO.md # List of tasks to be completed
687-
├── Taskfile.yml # Taskfile for managing tasks
688-
├── cliff.toml # Configuration file for the Cliff tool
689-
├── docs # Documentation directory
690-
│ ├── README.md # Main documentation landing page
691-
│ └── ...
692-
├── design # Design directory
693-
│ ├── README.md # Introduction to design
694-
│ ├── contracts # Any Open API, AsyncAPI, data contracts etc
695-
│ └── decisions # Architectural decision records localised to the service
696-
├── behaviour # Behaviour directory
697-
│ ├── README.md # Introduction to behaviour
698-
│ └── ... # Behaviour implementation encapsulating business logic
699-
├── experiences # Experiences directory
700-
│ ├── README.md # Introduction to experiences
701-
│ └── ... # UI implementation for behaviour such as web, app, AI etc
702-
├── publication # Publication directory
703-
│ ├── README.md # Introduction to publication
704-
│ └── ... # Implementation of data publications
705-
├── outcomes # Outcomes directory
706-
│ ├── README.md # Introduction to outcomes
707-
│ └── ... # UI implementation for outcomes such as reports, AI etc
708-
├── mkdocs.yml # MkDocs configuration file
709-
├── .editorconfig # Editor configuration file
710-
├── .gitattributes # Git attributes file
711-
├── .gitignore # Git ignore file
712-
└── .editorconfig # Editor configuration file
713-
714-
```
674+
<details class="example">
675+
<summary>Directory Interface Example</summary>
676+
<p>Here's a source aligned directory implementation:</p>
677+
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>├── AGENTS.md # Documentation for AI agents that interact with this codebase
678+
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>├── CHANGELOG.md # Documentation of notable changes
679+
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>├── CODE_OF_CONDUCT.md # Code of conduct for contributors
680+
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>├── CONTRIBUTING.md # How to contribute to this codebase
681+
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>├── LANGUAGE.md # Ubiquitous language for this codebase
682+
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>├── LICENSE.md # License for this codebase
683+
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>├── PULL_REQUEST_TEMPLATE.md # Template for pull requests
684+
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a>├── README.md # Overview of this codebase for users
685+
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a>├── RUNBOOK.md # Operational documentation for operators
686+
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a>├── SECURITY.md # Security policy for this codebase
687+
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a>├── SUPPORT.md # Support guidelines for this codebase
688+
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a>├── TODO.md # List of tasks to be completed
689+
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>├── Taskfile.yml # Taskfile for managing tasks
690+
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a>├── cliff.toml # Configuration file for the Cliff tool
691+
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a>├── docs # Documentation directory
692+
<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a>│ ├── README.md # Main documentation landing page
693+
<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a>│ └── ...
694+
<a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a>├── design # Design directory
695+
<a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a>│ ├── README.md # Introduction to design
696+
<a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a>│ ├── contracts # Any Open API, AsyncAPI, data contracts etc
697+
<a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a>│ └── decisions # Architectural decision records localised to the service
698+
<a id="__codelineno-1-22" name="__codelineno-1-22" href="#__codelineno-1-22"></a>├── behaviour # Behaviour directory
699+
<a id="__codelineno-1-23" name="__codelineno-1-23" href="#__codelineno-1-23"></a>│ ├── README.md # Introduction to behaviour
700+
<a id="__codelineno-1-24" name="__codelineno-1-24" href="#__codelineno-1-24"></a>│ └── ... # Behaviour implementation encapsulating business logic
701+
<a id="__codelineno-1-25" name="__codelineno-1-25" href="#__codelineno-1-25"></a>├── experiences # Experiences directory
702+
<a id="__codelineno-1-26" name="__codelineno-1-26" href="#__codelineno-1-26"></a>│ ├── README.md # Introduction to experiences
703+
<a id="__codelineno-1-27" name="__codelineno-1-27" href="#__codelineno-1-27"></a>│ └── ... # UI implementation for behaviour such as web, app, AI etc
704+
<a id="__codelineno-1-28" name="__codelineno-1-28" href="#__codelineno-1-28"></a>├── publication # Publication directory
705+
<a id="__codelineno-1-29" name="__codelineno-1-29" href="#__codelineno-1-29"></a>│ ├── README.md # Introduction to publication
706+
<a id="__codelineno-1-30" name="__codelineno-1-30" href="#__codelineno-1-30"></a>│ └── ... # Implementation of data publications
707+
<a id="__codelineno-1-31" name="__codelineno-1-31" href="#__codelineno-1-31"></a>├── outcomes # Outcomes directory
708+
<a id="__codelineno-1-32" name="__codelineno-1-32" href="#__codelineno-1-32"></a>│ ├── README.md # Introduction to outcomes
709+
<a id="__codelineno-1-33" name="__codelineno-1-33" href="#__codelineno-1-33"></a>│ └── ... # UI implementation for outcomes such as reports, AI etc
710+
<a id="__codelineno-1-34" name="__codelineno-1-34" href="#__codelineno-1-34"></a>├── mkdocs.yml # MkDocs configuration file
711+
<a id="__codelineno-1-35" name="__codelineno-1-35" href="#__codelineno-1-35"></a>├── .editorconfig # Editor configuration file
712+
<a id="__codelineno-1-36" name="__codelineno-1-36" href="#__codelineno-1-36"></a>├── .gitattributes # Git attributes file
713+
<a id="__codelineno-1-37" name="__codelineno-1-37" href="#__codelineno-1-37"></a>├── .gitignore # Git ignore file
714+
<a id="__codelineno-1-38" name="__codelineno-1-38" href="#__codelineno-1-38"></a>└── .editorconfig # Editor configuration file
715715
</code></pre></div>
716+
</details>
716717
<p><a class="md-button" href="../">← Previous: Tooling</a>
717718
<a class="md-button md-button--primary" href="../" style="float: right;">Next: Welcome →</a></p>
718719

@@ -735,7 +736,7 @@ <h2 id="source-aligned-services">Source Aligned Services<a class="headerlink" hr
735736
<span class="md-icon" title="Last update">
736737
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
737738
</span>
738-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="October 16, 2025 14:34:13 UTC">October 16, 2025</span>
739+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="October 16, 2025 14:37:12 UTC">October 16, 2025</span>
739740
</span>
740741

741742

0 commit comments

Comments
 (0)