feat: add MkDocs developer documentation site#45
Open
Tehsmash wants to merge 1 commit into
Open
Conversation
darrelmiller
approved these changes
Jun 25, 2026
tadasant
reviewed
Jun 25, 2026
| Identifies the version of the AI Catalog specification this document conforms to. Always present. Clients check this before processing. | ||
|
|
||
| **`entries`** | ||
| The list of artifacts. Each entry has four required fields: `identifier`, `displayName`, `mediaType`, and `url`. |
Member
|
@Tehsmash could you merge the conflicts? |
mindpower
reviewed
Jun 29, 2026
| { | ||
| "identifier": "urn:example:skill:code-review", | ||
| "displayName": "Code Review Assistant", | ||
| "mediaType": "application/agentskill+zip", |
Member
There was a problem hiding this comment.
mediaType -> type
agent-skills+zip
| { | ||
| "identifier": "urn:example:mcp:weather", | ||
| "displayName": "Weather Service", | ||
| "mediaType": "application/mcp-server-card+json", |
| { | ||
| "identifier": "urn:example:a2a:research", | ||
| "displayName": "Research Assistant", | ||
| "mediaType": "application/a2a-agent-card+json", |
| Identifies the version of the AI Catalog specification this document conforms to. Always present. Clients check this before processing. | ||
|
|
||
| **`entries`** | ||
| The list of artifacts. Each entry has four required fields: `identifier`, `displayName`, `mediaType`, and `url`. |
| A human-readable label shown in discovery UIs and client tooling. | ||
|
|
||
| **`mediaType`** | ||
| What kind of artifact this is. Clients use this to decide whether they can use the artifact — without fetching it. |
| "specVersion": "1.0", | ||
| "host": { | ||
| "displayName": "Acme Financial Corp", | ||
| "identifier": "did:web:acme-corp.com" |
Member
There was a problem hiding this comment.
did:air?. Please update the identifier based on: #36
| { | ||
| "identifier": "urn:acme:agent:finance", | ||
| "displayName": "Acme Finance Agent", | ||
| "mediaType": "application/ai-catalog+json", |
| "specVersion": "1.0", | ||
| "entries": [ | ||
| { | ||
| "identifier": "urn:acme:agent:finance:mcp", |
| { | ||
| "type": "SOC2-Type2", | ||
| "uri": "https://trust.acme-corp.com/reports/soc2.pdf", | ||
| "mediaType": "application/pdf", |
| { | ||
| "identifier": "urn:acme:agent:finance:a2a", | ||
| "displayName": "Acme Finance A2A Agent", | ||
| "mediaType": "application/a2a-agent-card+json", |
Member
Adds a developer-friendly documentation site powered by MkDocs and the Material theme, making ai-catalog accessible to developers beyond the normative W3C specification. Key changes: - docs/ — 11 pages covering overview, quickstart, 5 guides (creating, serving, consuming, organizing, trust), 3 annotated examples, and a spec signpost - mkdocs.yml — Material theme config with single left-hand nav, no tabs - pyproject.toml — adds [dependency-groups] docs with mkdocs-material - .github/workflows/publish-docs.yml — new CI workflow deploying docs to gh-pages root - tools/update_gh_pages.py — adds subdir mode and preserves spec/ in root mode - .github/workflows/publish-spec.yml — spec now deploys to spec/ subdirectory, freeing root for the docs site URL structure after deployment: https://agent-card.github.io/ai-catalog/ ← developer docs https://agent-card.github.io/ai-catalog/spec/ ← normative spec Signed-off-by: Sam Betts <1769706+Tehsmash@users.noreply.github.com>
Tehsmash
force-pushed
the
feat/mkdocs-documentation-site
branch
from
b13978f to
dc6b06e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a developer-friendly documentation site to make ai-catalog accessible to developers beyond the normative W3C specification.
docs/: overview, quickstart, 5 guides (creating a catalog, serving, consuming, organizing, adding trust), 3 annotated examples, and a spec signpostmkdocs.yml) with a single left-hand navigation, light/dark mode, and code copy/), spec moved to/spec/publish-docs.ymlCI workflow that builds and deploys the docs site to gh-pages rootupdate_gh_pages.pywith asubdirmode for deploying to named subdirectories; root mode now preservesspec/alongsidepr/publish-spec.ymlto deploy the spec tospec/using the new subdir modemkdocs-materialadded topyproject.tomlas a[dependency-groups]docs dependencyLocal preview