doc updates

This commit is contained in:
John Lancaster
2026-06-21 18:12:58 -05:00
parent 69cd9037a3
commit 1f7e63267a
10 changed files with 75 additions and 52 deletions
+5 -5
View File
@@ -26,9 +26,9 @@ This architecture is anchored by three contracts:
Detailed contract pages: Detailed contract pages:
1. [Content Contract](./content.md) 1. [Content Contract](./contracts/content.md)
2. [Frontmatter Contract](./frontmatter.md) 2. [Frontmatter Contract](./contracts/frontmatter.md)
3. [URI Contract](./uris.md) 3. [URI Contract](./contracts/uris.md)
This architecture keeps authored content human-friendly while preserving machine-stable contracts. This architecture keeps authored content human-friendly while preserving machine-stable contracts.
@@ -125,7 +125,7 @@ flowchart TD
Each skill declares frontmatter in `docs/skills/<skill-id>/SKILL.md`. Each skill declares frontmatter in `docs/skills/<skill-id>/SKILL.md`.
For the full field-level contract, validation model, and FastMCP metadata mapping, see [Frontmatter Contract](./frontmatter.md). For the full field-level contract, validation model, and FastMCP metadata mapping, see [Frontmatter Contract](./contracts/frontmatter.md).
Anthropic-facing required fields: Anthropic-facing required fields:
@@ -147,7 +147,7 @@ No `metadata.yaml` sidecar is part of the end-state contract.
Canonical resource URIs are: Canonical resource URIs are:
For the full URI semantics, parameter validation rules, and compatibility policy, see [URI Contract](./uris.md). For the full URI semantics, parameter validation rules, and compatibility policy, see [URI Contract](./contracts/uris.md).
1. resource://skills/<skill_id>/document 1. resource://skills/<skill_id>/document
2. resource://skills/<skill_id>/references/<ref_id> 2. resource://skills/<skill_id>/references/<ref_id>
+15
View File
@@ -0,0 +1,15 @@
---
icon: lucide/file-check-2
---
# Contracts
This section groups the core data and contract documents for the repository.
## Pages
1. [Content Contract](./content.md)
2. [Frontmatter Contract](./frontmatter.md)
3. [URI Contract](./uris.md)
Use these pages as the normative source for authored content layout, frontmatter schema, and canonical MCP URI semantics.
+4 -3
View File
@@ -39,9 +39,10 @@ When the server is running, the health check is available at `/healthz` and the
## Architecture ## Architecture
- [Resource-First Pattern Module Architecture](./architecture.md) - [Resource-First Pattern Module Architecture](./architecture.md)
- [Content Contract](./content.md) - [Contracts](./contracts/index.md)
- [Frontmatter Contract](./frontmatter.md) - [Content Contract](./contracts/content.md)
- [URI Contract](./uris.md) - [Frontmatter Contract](./contracts/frontmatter.md)
- [URI Contract](./contracts/uris.md)
- [Static Docs Hosting Pattern](./mcp_layout.md) - [Static Docs Hosting Pattern](./mcp_layout.md)
- [Skill Usage Mechanics](./usage.md) - [Skill Usage Mechanics](./usage.md)
- [Copilot MCP Mechanics](./copilot.md) - [Copilot MCP Mechanics](./copilot.md)
+19 -38
View File
@@ -32,55 +32,35 @@ treeView-beta
"zensical.toml" "zensical.toml"
"docs" "docs"
"index.md" "index.md"
"architecture.md" "<project-docs>.md"
"content.md" "contracts"
"frontmatter.md" "index.md"
"<contract-pages>.md"
"mcp_layout.md" "mcp_layout.md"
"uris.md" "prompts"
"<prompt-id>"
"PROMPT.md"
"references"
"skills" "skills"
"new-skill" "<skill-id>"
"SKILL.md"
"references"
"copilot-customization"
"SKILL.md"
"references"
"fastapi-async-sqlalchemy-modernization"
"SKILL.md"
"references"
"fastapi-uv-docker"
"SKILL.md"
"references"
"nicegui"
"SKILL.md"
"references"
"nicegui-ui-customization"
"SKILL.md"
"references"
"pytest-scaffolding"
"SKILL.md"
"references"
"python-logging-dictconfig"
"SKILL.md"
"references"
"vscode-configuration"
"SKILL.md"
"references"
"zensical-docs"
"SKILL.md" "SKILL.md"
"references" "references"
"<reference>.md"
"site" "site"
"static build output" "static build output"
"src" "src"
"personal_mcp" "personal_mcp"
"__init__.py"
"main.py" "main.py"
"mcp.py" "mcp.py"
"web"
"app.py"
"docs_mount.py"
"catalog" "catalog"
"server.py" "<catalog-modules>.py"
"registry"
"<registry-modules>.py"
"web"
"<web-modules>.py"
"skills" "skills"
"document_loader.py" "<skills-modules>.py"
``` ```
Notes: Notes:
@@ -88,7 +68,8 @@ Notes:
1. docs contains both project-authored pages and the canonical skill Markdown tree. 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. docs/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. docs/prompts contains canonical prompt Markdown used for prompt catalog and document surfaces.
5. MCP resources and docs site read from the same Markdown sources.
## Runtime Composition ## Runtime Composition
@@ -0,0 +1,23 @@
---
name: initial-test-structure
description: Create an initial pytest test structure for a target project scope using repository conventions.
x-personal-mcp:
id: initial-test-structure
version: 1.0.0
tags:
- pytest
- testing
capabilities:
- resource://prompts/initial-test-structure/document
arguments:
target_scope:
type: string
description: Target project, package, or module to scaffold tests for.
required: false
---
# Prompt For Creating Initial Test Structure
Create an initial test structure in `./tests` based around pytest best practices.
Use for an overview of best practices `resource://skills/pytest-scaffolding/document`. Take into account the naming structure too and pull in other relevant resources like for fastapi testing
+3 -3
View File
@@ -46,10 +46,10 @@ If the domain includes naming or hierarchy conventions, include a dedicated nami
1. Use this file as the baseline template for new skill authoring. 1. Use this file as the baseline template for new skill authoring.
2. Read and follow these docs before implementing a new skill: 2. Read and follow these docs before implementing a new skill:
- [docs/architecture.md](../../architecture.md) - [docs/architecture.md](../../architecture.md)
- [docs/content.md](../../content.md) - [docs/contracts/content.md](../../contracts/content.md)
- [docs/frontmatter.md](../../frontmatter.md) - [docs/contracts/frontmatter.md](../../contracts/frontmatter.md)
- [docs/mcp_layout.md](../../mcp_layout.md) - [docs/mcp_layout.md](../../mcp_layout.md)
- [docs/uris.md](../../uris.md) - [docs/contracts/uris.md](../../contracts/uris.md)
## Canonical Skill Shape ## Canonical Skill Shape
+6 -3
View File
@@ -48,9 +48,12 @@ nav = [
{ "Home" = "index.md" }, { "Home" = "index.md" },
{ "Guide" = [ { "Guide" = [
{ "Arch" = "architecture.md" }, { "Arch" = "architecture.md" },
{ "Content" = "content.md" }, { "Contracts" = [
{ "Frontmatter" = "frontmatter.md" }, { "Overview" = "contracts/index.md" },
{ "URIs" = "uris.md" }, { "Content" = "contracts/content.md" },
{ "Frontmatter" = "contracts/frontmatter.md" },
{ "URIs" = "contracts/uris.md" },
] },
{ "MCP" = "mcp_layout.md" }, { "MCP" = "mcp_layout.md" },
{ "Copilot" = "copilot.md" }, { "Copilot" = "copilot.md" },
{ "Usage" = "usage.md" }, { "Usage" = "usage.md" },