doc updates for new structure
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
This repository is resource-first.
|
||||
|
||||
- Canonical skill guidance lives in `docs/skills/<skill-id>/SKILL.md`.
|
||||
- Canonical skill guidance lives in `src/personal_mcp/docs/skills/<skill-id>/SKILL.md`.
|
||||
- Skills are exposed through FastMCP's native `skill://` resource family.
|
||||
- Prompts are exposed through native MCP prompt operations (`prompts/list`, `prompts/get`).
|
||||
- General documentation pages are exposed through `resource://docs/{path*}`.
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
---
|
||||
name: Authoring Content
|
||||
description: "Use when editing Markdown under docs/. Routes authors to the canonical docs ownership, layout, and symlink guidance."
|
||||
applyTo: 'docs/**/*.md'
|
||||
description: "Use when editing Markdown under src/personal_mcp/docs/. Routes authors to the canonical docs ownership and layout guidance."
|
||||
applyTo: 'src/personal_mcp/docs/**/*.md'
|
||||
---
|
||||
|
||||
For edits under `docs/`, use the [Authoring Guide](../../docs/authoring.md) as the entry point for content placement and contracts.
|
||||
For edits under `src/personal_mcp/docs/`, use the [Authoring Guide](../../src/personal_mcp/docs/authoring.md) as the entry point for content placement and contracts.
|
||||
|
||||
For source-tree ownership, symlink, packaging, or runtime questions, follow [Source Tree Ownership](../../docs/authoring.md). Treat that section as authoritative instead of restating its guidance here.
|
||||
For source-tree ownership, packaging, or runtime questions, follow [Source Tree Ownership](../../src/personal_mcp/docs/authoring.md). Treat that section as authoritative instead of restating its guidance here.
|
||||
|
||||
|
||||
Primary references:
|
||||
- [Skill contract](../../docs/contracts/skill_contract.md)
|
||||
- [Prompt contract](../../docs/contracts/prompt.md)
|
||||
- [Frontmatter contract](../../docs/contracts/frontmatter.md)
|
||||
- [URI contract](../../docs/contracts/uris.md)
|
||||
- [Skill contract](../../src/personal_mcp/docs/contracts/skill_contract.md)
|
||||
- [Prompt contract](../../src/personal_mcp/docs/contracts/prompt.md)
|
||||
- [Frontmatter contract](../../src/personal_mcp/docs/contracts/frontmatter.md)
|
||||
- [URI contract](../../src/personal_mcp/docs/contracts/uris.md)
|
||||
- `skill://zensical-docs/SKILL.md`
|
||||
|
||||
Inspect `skill://zensical-docs/_manifest` only when a supporting documentation reference is needed.
|
||||
|
||||
@@ -21,4 +21,4 @@ Execution pattern:
|
||||
|
||||
If task intent is ambiguous, ask one clarifying question before editing.
|
||||
|
||||
Be sure to also refer to the [testing page](../../docs/testing.md) page for design detail
|
||||
Be sure to also refer to the [testing page](../../src/personal_mcp/docs/testing.md) for design detail.
|
||||
|
||||
@@ -26,11 +26,11 @@ Use this prompt after test scaffolding exists and method names/docstrings are al
|
||||
|
||||
Load these in order and use only what matches the task:
|
||||
|
||||
1. Core defaults: [pytest scaffolding skill](../../docs/skills/pytesting/SKILL.md)
|
||||
2. Naming/hierarchy preservation: [naming and organization](../../docs/skills/pytesting/references/naming-and-organization.md)
|
||||
3. Baseline pytest fixtures/markers: [pytest docs notes](../../docs/skills/pytesting/references/pytest-docs.md)
|
||||
4. FastAPI-specific behavior (only when needed): [fastapi testing](../../docs/skills/pytesting/references/fastapi-testing.md)
|
||||
5. SQLAlchemy-specific behavior (only when needed): [sqlalchemy testing](../../docs/skills/pytesting/references/sqlalchemy-testing.md)
|
||||
1. Core defaults: [pytest scaffolding skill](../../src/personal_mcp/docs/skills/pytesting/SKILL.md)
|
||||
2. Naming/hierarchy preservation: [naming and organization](../../src/personal_mcp/docs/skills/pytesting/references/naming-and-organization.md)
|
||||
3. Baseline pytest fixtures/markers: [pytest docs notes](../../src/personal_mcp/docs/skills/pytesting/references/pytest-docs.md)
|
||||
4. FastAPI-specific behavior (only when needed): [fastapi testing](../../src/personal_mcp/docs/skills/pytesting/references/fastapi-testing.md)
|
||||
5. SQLAlchemy-specific behavior (only when needed): [sqlalchemy testing](../../src/personal_mcp/docs/skills/pytesting/references/sqlalchemy-testing.md)
|
||||
|
||||
## Workflow
|
||||
|
||||
|
||||
@@ -24,8 +24,8 @@ Use this prompt to do in one run what we have been doing manually in chat:
|
||||
|
||||
## Repository Rules To Apply
|
||||
|
||||
- Use [pytest scaffolding skill](../../docs/skills/pytesting/SKILL.md) for strategy and defaults.
|
||||
- Use [naming and organization reference](../../docs/skills/pytesting/references/naming-and-organization.md) before finalizing hierarchy.
|
||||
- Use [pytest scaffolding skill](../../src/personal_mcp/docs/skills/pytesting/SKILL.md) for strategy and defaults.
|
||||
- Use [naming and organization reference](../../src/personal_mcp/docs/skills/pytesting/references/naming-and-organization.md) before finalizing hierarchy.
|
||||
- Use `uv run pytest --collect-only -q` as structural validation.
|
||||
- Default to a source-mirror style adapted to this repository:
|
||||
- map selected modules to `tests/` with concise path segments when requested
|
||||
|
||||
Reference in New Issue
Block a user