completing move
This commit is contained in:
@@ -47,7 +47,7 @@ Typical catalog resources:
|
|||||||
|
|
||||||
### Content Sources
|
### Content Sources
|
||||||
|
|
||||||
Content is authored in markdown and managed as long-form reference material. Resource handlers expose the same authored documents through stable resource URIs.
|
Content is authored in markdown under `docs/` and managed as long-form reference material. Skill documents and companion references now live under `docs/skills/`, while project-authored pages remain alongside them in the docs tree. Resource handlers expose the same authored documents through stable resource URIs.
|
||||||
|
|
||||||
### Static Docs Surface
|
### Static Docs Surface
|
||||||
|
|
||||||
@@ -155,8 +155,8 @@ Out-of-scope:
|
|||||||
|
|
||||||
Existing markdown reference sets are valid examples of authored source material for this architecture:
|
Existing markdown reference sets are valid examples of authored source material for this architecture:
|
||||||
|
|
||||||
1. ../skills/pytest-scaffolding/references/pytest-docs.md
|
1. ../docs/skills/pytest-scaffolding/references/pytest-docs.md
|
||||||
2. ../skills/python-logging-dictconfig/references/python-logging-docs.md
|
2. ../docs/skills/python-logging-dictconfig/references/python-logging-docs.md
|
||||||
3. ../skills/fastapi-uv-docker/references/fastapi-best-practices.md
|
3. ../docs/skills/fastapi-uv-docker/references/fastapi-best-practices.md
|
||||||
|
|
||||||
These inputs are treated as content sources, while resource URIs and catalog payloads remain the machine-facing contracts.
|
These inputs are treated as content sources, while resource URIs and catalog payloads remain the machine-facing contracts.
|
||||||
|
|||||||
+18
-18
@@ -30,18 +30,18 @@ treeView-beta
|
|||||||
"index.md"
|
"index.md"
|
||||||
"architecture.md"
|
"architecture.md"
|
||||||
"mcp_layout.md"
|
"mcp_layout.md"
|
||||||
|
"skills"
|
||||||
|
"pytest-scaffolding"
|
||||||
|
"SKILL.md"
|
||||||
|
"references"
|
||||||
|
"python-logging-dictconfig"
|
||||||
|
"SKILL.md"
|
||||||
|
"references"
|
||||||
|
"fastapi-uv-docker"
|
||||||
|
"SKILL.md"
|
||||||
|
"references"
|
||||||
"site"
|
"site"
|
||||||
"static build output"
|
"static build output"
|
||||||
"skills"
|
|
||||||
"pytest-scaffolding"
|
|
||||||
"SKILL.md"
|
|
||||||
"references"
|
|
||||||
"python-logging-dictconfig"
|
|
||||||
"SKILL.md"
|
|
||||||
"references"
|
|
||||||
"fastapi-uv-docker"
|
|
||||||
"SKILL.md"
|
|
||||||
"references"
|
|
||||||
"src"
|
"src"
|
||||||
"personal_mcp"
|
"personal_mcp"
|
||||||
"main.py"
|
"main.py"
|
||||||
@@ -58,9 +58,9 @@ treeView-beta
|
|||||||
|
|
||||||
Notes:
|
Notes:
|
||||||
|
|
||||||
1. docs contains project-authored pages.
|
1. docs contains both project-authored pages and the canonical skill Markdown tree.
|
||||||
2. site contains static build output only.
|
2. site contains static build output only.
|
||||||
3. skills contains canonical skill Markdown and reference Markdown.
|
3. docs/skills contains canonical skill Markdown and reference Markdown.
|
||||||
4. MCP resources and docs site read from the same Markdown sources.
|
4. MCP resources and docs site read from the same Markdown sources.
|
||||||
|
|
||||||
## Runtime Composition
|
## Runtime Composition
|
||||||
@@ -93,7 +93,7 @@ No runtime markdown conversion is required.
|
|||||||
The published docs site always contains both:
|
The published docs site always contains both:
|
||||||
|
|
||||||
1. Project-authored docs pages
|
1. Project-authored docs pages
|
||||||
2. Skill Markdown content from skills/*/SKILL.md and references
|
2. Skill Markdown content from docs/skills/*/SKILL.md and references
|
||||||
|
|
||||||
This ensures the public docs reflect architectural guidance and the exact Markdown served by MCP.
|
This ensures the public docs reflect architectural guidance and the exact Markdown served by MCP.
|
||||||
|
|
||||||
@@ -103,8 +103,8 @@ MCP resources map directly to canonical Markdown documents.
|
|||||||
|
|
||||||
Example mapping model:
|
Example mapping model:
|
||||||
|
|
||||||
1. skills/<slug>/SKILL.md -> resource://skills/<id>/document
|
1. docs/skills/<slug>/SKILL.md -> resource://skills/<id>/document
|
||||||
2. skills/<slug>/references/*.md -> referenced sections or linked companion documents
|
2. docs/skills/<slug>/references/*.md -> referenced sections or linked companion documents
|
||||||
|
|
||||||
Catalog resources provide discovery metadata and stable identifiers.
|
Catalog resources provide discovery metadata and stable identifiers.
|
||||||
|
|
||||||
@@ -153,8 +153,8 @@ This keeps docs publication explicit and predictable.
|
|||||||
|
|
||||||
Existing reference docs remain valid content inputs in this pattern:
|
Existing reference docs remain valid content inputs in this pattern:
|
||||||
|
|
||||||
1. ../skills/pytest-scaffolding/references/pytest-docs.md
|
1. ../docs/skills/pytest-scaffolding/references/pytest-docs.md
|
||||||
2. ../skills/python-logging-dictconfig/references/python-logging-docs.md
|
2. ../docs/skills/python-logging-dictconfig/references/python-logging-docs.md
|
||||||
3. ../skills/fastapi-uv-docker/references/fastapi-best-practices.md
|
3. ../docs/skills/fastapi-uv-docker/references/fastapi-best-practices.md
|
||||||
|
|
||||||
These are source documents, not deployment artifacts.
|
These are source documents, not deployment artifacts.
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ def _repo_root() -> Path:
|
|||||||
|
|
||||||
def load_skill_document(*, skill_id: str, skill_slug: str) -> dict[str, str]:
|
def load_skill_document(*, skill_id: str, skill_slug: str) -> dict[str, str]:
|
||||||
"""Load the canonical skill markdown document for an MCP skill."""
|
"""Load the canonical skill markdown document for an MCP skill."""
|
||||||
document_path = _repo_root() / "skills" / skill_slug / "SKILL.md"
|
document_path = _repo_root() / "docs" / "skills" / skill_slug / "SKILL.md"
|
||||||
if not document_path.exists():
|
if not document_path.exists():
|
||||||
raise FileNotFoundError(
|
raise FileNotFoundError(
|
||||||
f"Missing skill document for '{skill_id}': {document_path}"
|
f"Missing skill document for '{skill_id}': {document_path}"
|
||||||
|
|||||||
Reference in New Issue
Block a user