Skip to content

Commit cffd4db

Browse files
author
committed
Deployed 65c5ad9 with MkDocs version: 1.6.1
1 parent 9a20705 commit cffd4db

File tree

2 files changed

+75
-52
lines changed

2 files changed

+75
-52
lines changed

‎examples/index.html‎

Lines changed: 74 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -589,9 +589,18 @@
589589
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
590590

591591
<li class="md-nav__item">
592-
<a href="#documentation-services" class="md-nav__link">
592+
<a href="#minimal-services" class="md-nav__link">
593593
<span class="md-ellipsis">
594-
Documentation Services
594+
Minimal Services
595+
</span>
596+
</a>
597+
598+
</li>
599+
600+
<li class="md-nav__item">
601+
<a href="#open-source-documentation-services" class="md-nav__link">
602+
<span class="md-ellipsis">
603+
Open Source Documentation Services
595604
</span>
596605
</a>
597606

@@ -639,41 +648,29 @@
639648

640649

641650
<h1 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h1>
642-
<h2 id="documentation-services">Documentation Services<a class="headerlink" href="#documentation-services" title="Permanent link">&para;</a></h2>
643-
<ul>
644-
<li><a href="https://github.com/codebase-interface/codebaseinterface" target="_blank">Codebase Interface</a></li>
645-
</ul>
651+
<h2 id="minimal-services">Minimal Services<a class="headerlink" href="#minimal-services" title="Permanent link">&para;</a></h2>
646652
<details class="example">
647653
<summary>Directory Interface Example</summary>
648654
<p>Here's the codebase interface directory implementation:</p>
649655
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>├── AGENTS.md # Documentation for AI agents that interact with this codebase
650-
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>├── CHANGELOG.md # Documentation of notable changes
651-
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>├── CODE_OF_CONDUCT.md # Code of conduct for contributors
652-
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>├── CONTRIBUTING.md # How to contribute to this codebase
653-
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>├── LANGUAGE.md # Ubiquitous language for this codebase
654-
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>├── LICENSE.md # License for this codebase
655-
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>├── PULL_REQUEST_TEMPLATE.md # Template for pull requests
656-
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>├── README.md # Overview of this codebase for users
657-
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>├── RUNBOOK.md # Operational documentation for operators
658-
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>├── SECURITY.md # Security policy for this codebase
659-
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>├── SUPPORT.md # Support guidelines for this codebase
660-
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a>├── TODO.md # List of tasks to be completed
661-
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a>├── Taskfile.yml # Taskfile for managing tasks
662-
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>├── cliff.toml # Configuration file for the Cliff tool
663-
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>├── docs # Documentation directory
664-
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a>│ ├── README.md # Main documentation landing page
665-
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>│ └── ...
666-
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a>├── mkdocs.yml # MkDocs configuration file
667-
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a>├── .editorconfig # Editor configuration file
668-
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a>├── .gitattributes # Git attributes file
669-
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>├── .gitignore # Git ignore file
670-
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a>└── .editorconfig # Editor configuration file
656+
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>├── CONTRIBUTING.md # How to contribute to this codebase
657+
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>├── PULL_REQUEST_TEMPLATE.md # Template for pull requests
658+
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>├── README.md # Overview of this codebase for users
659+
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>├── RUNBOOK.md # Operational documentation for operators
660+
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>├── SUPPORT.md # Support guidelines for this codebase
661+
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>├── Taskfile.yml # Taskfile for managing tasks
662+
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>├── .gitattributes # Git attributes file
663+
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>├── .gitignore # Git ignore file
664+
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>└── .editorconfig # Editor configuration file
671665
</code></pre></div>
672666
</details>
673-
<h2 id="source-aligned-services">Source Aligned Services<a class="headerlink" href="#source-aligned-services" title="Permanent link">&para;</a></h2>
667+
<h2 id="open-source-documentation-services">Open Source Documentation Services<a class="headerlink" href="#open-source-documentation-services" title="Permanent link">&para;</a></h2>
668+
<ul>
669+
<li><a href="https://github.com/codebase-interface/codebaseinterface" target="_blank">Codebase Interface</a></li>
670+
</ul>
674671
<details class="example">
675672
<summary>Directory Interface Example</summary>
676-
<p>Here's a source aligned directory implementation:</p>
673+
<p>Here's the codebase interface directory implementation:</p>
677674
<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
678675
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>├── CHANGELOG.md # Documentation of notable changes
679676
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>├── CODE_OF_CONDUCT.md # Code of conduct for contributors
@@ -691,27 +688,53 @@ <h2 id="source-aligned-services">Source Aligned Services<a class="headerlink" hr
691688
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a>├── docs # Documentation directory
692689
<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a>│ ├── README.md # Main documentation landing page
693690
<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
691+
<a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a>├── mkdocs.yml # MkDocs configuration file
692+
<a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a>├── .gitattributes # Git attributes file
693+
<a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a>├── .gitignore # Git ignore file
694+
<a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a>└── .editorconfig # Editor configuration file
695+
</code></pre></div>
696+
</details>
697+
<h2 id="source-aligned-services">Source Aligned Services<a class="headerlink" href="#source-aligned-services" title="Permanent link">&para;</a></h2>
698+
<details class="example">
699+
<summary>Directory Interface Example</summary>
700+
<p>Here's a source aligned directory implementation:</p>
701+
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>├── AGENTS.md # Documentation for AI agents that interact with this codebase
702+
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>├── CHANGELOG.md # Documentation of notable changes
703+
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>├── CODE_OF_CONDUCT.md # Code of conduct for contributors
704+
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a>├── CONTRIBUTING.md # How to contribute to this codebase
705+
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>├── LANGUAGE.md # Ubiquitous language for this codebase
706+
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a>├── LICENSE.md # License for this codebase
707+
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a>├── PULL_REQUEST_TEMPLATE.md # Template for pull requests
708+
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a>├── README.md # Overview of this codebase for users
709+
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a>├── RUNBOOK.md # Operational documentation for operators
710+
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a>├── SECURITY.md # Security policy for this codebase
711+
<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a>├── SUPPORT.md # Support guidelines for this codebase
712+
<a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a>├── TODO.md # List of tasks to be completed
713+
<a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a>├── Taskfile.yml # Taskfile for managing tasks
714+
<a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a>├── cliff.toml # Configuration file for the Cliff tool
715+
<a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a>├── docs # Documentation directory
716+
<a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a>│ ├── README.md # Main documentation landing page
717+
<a id="__codelineno-2-17" name="__codelineno-2-17" href="#__codelineno-2-17"></a>│ └── ...
718+
<a id="__codelineno-2-18" name="__codelineno-2-18" href="#__codelineno-2-18"></a>├── design # Design directory
719+
<a id="__codelineno-2-19" name="__codelineno-2-19" href="#__codelineno-2-19"></a>│ ├── README.md # Introduction to design
720+
<a id="__codelineno-2-20" name="__codelineno-2-20" href="#__codelineno-2-20"></a>│ ├── contracts # Any Open API, AsyncAPI, data contracts etc
721+
<a id="__codelineno-2-21" name="__codelineno-2-21" href="#__codelineno-2-21"></a>│ └── decisions # Architectural decision records localised to the service
722+
<a id="__codelineno-2-22" name="__codelineno-2-22" href="#__codelineno-2-22"></a>├── behaviour # Behaviour directory
723+
<a id="__codelineno-2-23" name="__codelineno-2-23" href="#__codelineno-2-23"></a>│ ├── README.md # Introduction to behaviour
724+
<a id="__codelineno-2-24" name="__codelineno-2-24" href="#__codelineno-2-24"></a>│ └── ... # Behaviour implementation encapsulating business logic
725+
<a id="__codelineno-2-25" name="__codelineno-2-25" href="#__codelineno-2-25"></a>├── experiences # Experiences directory
726+
<a id="__codelineno-2-26" name="__codelineno-2-26" href="#__codelineno-2-26"></a>│ ├── README.md # Introduction to experiences
727+
<a id="__codelineno-2-27" name="__codelineno-2-27" href="#__codelineno-2-27"></a>│ └── ... # UI implementation for behaviour such as web, app, AI etc
728+
<a id="__codelineno-2-28" name="__codelineno-2-28" href="#__codelineno-2-28"></a>├── publication # Publication directory
729+
<a id="__codelineno-2-29" name="__codelineno-2-29" href="#__codelineno-2-29"></a>│ ├── README.md # Introduction to publication
730+
<a id="__codelineno-2-30" name="__codelineno-2-30" href="#__codelineno-2-30"></a>│ └── ... # Implementation of data publications
731+
<a id="__codelineno-2-31" name="__codelineno-2-31" href="#__codelineno-2-31"></a>├── outcomes # Outcomes directory
732+
<a id="__codelineno-2-32" name="__codelineno-2-32" href="#__codelineno-2-32"></a>│ ├── README.md # Introduction to outcomes
733+
<a id="__codelineno-2-33" name="__codelineno-2-33" href="#__codelineno-2-33"></a>│ └── ... # UI implementation for outcomes such as reports, AI etc
734+
<a id="__codelineno-2-34" name="__codelineno-2-34" href="#__codelineno-2-34"></a>├── mkdocs.yml # MkDocs configuration file
735+
<a id="__codelineno-2-35" name="__codelineno-2-35" href="#__codelineno-2-35"></a>├── .gitattributes # Git attributes file
736+
<a id="__codelineno-2-36" name="__codelineno-2-36" href="#__codelineno-2-36"></a>├── .gitignore # Git ignore file
737+
<a id="__codelineno-2-37" name="__codelineno-2-37" href="#__codelineno-2-37"></a>└── .editorconfig # Editor configuration file
715738
</code></pre></div>
716739
</details>
717740
<!-- markdownlint-disable MD033 -->
@@ -756,7 +779,7 @@ <h2 id="source-aligned-services">Source Aligned Services<a class="headerlink" hr
756779
<span class="md-icon" title="Last update">
757780
<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>
758781
</span>
759-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="October 16, 2025 14:48:58 UTC">October 16, 2025</span>
782+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="October 16, 2025 18:59:24 UTC">October 16, 2025</span>
760783
</span>
761784

762785

0 commit comments

Comments
 (0)