john/prompts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc updates for new structure

Browse Source
This commit is contained in:
John Lancaster
2026-08-30 00:16:58 -05:00
parent afedcda930
commit 88474a75f5
14 changed files with 65 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/personal_mcp/docs/architecture.md
+6 -6
View File
@@ -6,7 +6,7 @@ icon: lucide/library
## Overview
The application combines a FastMCP server with a pre-built Zensical documentation site. Markdown under `docs/` is the single authored content tree, while native FastMCP providers own skill and prompt discovery.
The application combines a FastMCP server with a pre-built Zensical documentation site. Markdown under `src/personal_mcp/docs/` is the single authored content tree, while native FastMCP providers own skill and prompt discovery.
The runtime has four content paths:
@@ -23,8 +23,8 @@ There is no custom skill catalog, prompt catalog, or per-prompt Python module.
Each skill owns one directory:
1. `docs/skills/<skill-id>/SKILL.md`
2. `docs/skills/<skill-id>/<supporting-path>`
1. `src/personal_mcp/docs/skills/<skill-id>/SKILL.md`
2. `src/personal_mcp/docs/skills/<skill-id>/<supporting-path>`
`SkillsDirectoryProvider` publishes:
@@ -36,7 +36,7 @@ The provider parses standard skill frontmatter and generates the manifest. The g
### Prompts
Each prompt has one source: `docs/prompts/<prompt-id>/PROMPT.md`. Its nested `prompt` frontmatter owns runtime metadata and argument declarations, while its body owns canonical prose.
Each prompt has one source: `src/personal_mcp/docs/prompts/<prompt-id>/PROMPT.md`. Its nested `prompt` frontmatter owns runtime metadata and argument declarations, while its body owns canonical prose.
The custom provider reads packaged Markdown with `importlib.resources`, validates metadata and exact placeholder-to-argument equality, and creates native FastMCP prompt objects. It rescans on each list and get request, so an editable deployment observes file additions, edits, and deletions without a restart.
@@ -65,7 +65,7 @@ Server construction is lazy with respect to package import. Each application pro
## Packaging
The repository root `docs/` directory is the only authored Markdown source. `src/personal_mcp/docs` is a relative symlink used by source checkouts and editable installs. Hatchling follows it and stores regular files beneath `personal_mcp/docs/` in the wheel.
The regular directory `src/personal_mcp/docs/` is the only authored Markdown source. The `uv_build` backend includes it as package data beneath `personal_mcp/docs/` in built distributions.
Runtime reads are package-relative:
@@ -92,7 +92,7 @@ Only these canonical provider and protocol surfaces are registered.
## Static Documentation
Zensical builds `docs/` into `site/` before deployment. FastAPI mounts that immutable output in the same process that hosts FastMCP. Generated `site/` files are deployment assets and are never an authored source.
Zensical builds `src/personal_mcp/docs/` into `src/personal_mcp/site/` before deployment. FastAPI mounts that immutable output in the same process that hosts FastMCP. Generated site files are deployment assets and are never an authored source.
## Validation