diff --git a/README.md b/README.md index a838bc4..98b2709 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ SPDX-License-Identifier: MIT # Diffo Example -[![Module Version](https://img.shields.io/hexpm/v/diffo)](https://hex.pm/packages/diffo_example) +[![Module Version](https://img.shields.io/hexpm/v/diffo_example)](https://hex.pm/packages/diffo_example) [![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen)](https://hexdocs.pm/diffo_example/) [![License](https://img.shields.io/hexpm/l/diffo)](https://github.com/diffo-dev/diffo_example/blob/master/LICENSES/MIT.md) [![REUSE status](https://api.reuse.software/badge/github.com/diffo-dev/diffo_example)](https://api.reuse.software/info/github.com/diffo-dev/diffo_example) diff --git a/documentation/domains/provider.md b/documentation/domains/provider.md index d8e0cee..213e2d9 100644 --- a/documentation/domains/provider.md +++ b/documentation/domains/provider.md @@ -22,7 +22,7 @@ Every `Instance` declares a `Specification` — the *type* of thing it is (`shel ### Instance -A concrete thing of a specification — a particular `shelf` named "QDONC-0001" with a unique id. You created instances with `:build` actions (e.g. `Access.build_shelf/1`). Each instance is a node in the graph. +A concrete thing of a specification — a particular `shelf` named "QDONC-0001" with a unique id. You created instances with `:build` actions (e.g. `DiffoExample.Access.build_shelf/1`). Each instance is a node in the graph. ### Characteristic diff --git a/documentation/how_to/setup_mcp.md b/documentation/how_to/setup_mcp.md index 20acaff..e16249e 100644 --- a/documentation/how_to/setup_mcp.md +++ b/documentation/how_to/setup_mcp.md @@ -204,9 +204,8 @@ a second `forward "/mcp_admin"` with its own tool list. ## Adding new tools When you add a new action to a resource, add it to the appropriate domain's -`tools do` block as well. See [AGENTS.md](../../AGENTS.md) for the -keep-in-alignment convention. The compile won't catch a missing tool entry; -the action will simply be invisible to MCP clients. +`tools do` block as well. The compile won't catch a missing tool entry; the +action will simply be invisible to MCP clients. ## Authorisation diff --git a/mix.exs b/mix.exs index c458e96..819a8ef 100644 --- a/mix.exs +++ b/mix.exs @@ -23,7 +23,6 @@ defmodule DiffoExample.MixProject do # ex_doc source_url: "https://github.com/diffo-dev/diffo_example/", homepage_url: "http://diffo.dev/diffo_example/", - docs: [main: "readme", extras: ["README.md"]], elixirc_paths: elixirc_paths(Mix.env()), # agent stuff usage_rules: usage_rules(), @@ -63,9 +62,11 @@ defmodule DiffoExample.MixProject do "README.md": [title: "Guide"], "documentation/domains/access.md": [title: "The Access Domain"], "documentation/domains/diffo_example_access.livemd": [title: "Access Livebook"], + "documentation/domains/_access_api.md": [title: "Access Domain API"], "documentation/domains/provider.md": [title: "The Provider Domain"], "documentation/domains/nbn.md": [title: "The NBN Domain"], "documentation/domains/diffo_example_nbn.livemd": [title: "NBN Livebook"], + "documentation/domains/_nbn_api.md": [title: "NBN Domain API"], "documentation/how_to/setup_mcp.md": [title: "Setup the MCP server"], "LICENSES/MIT.md": [title: "License"] ],