big rework
This commit is contained in:
John Lancaster
+114
-109
@@ -13,6 +13,9 @@
|
||||
# Read more: https://zensical.org/docs/setup/basics/#site_name
|
||||
site_name = "Documentation"
|
||||
|
||||
site_dir = "src/personal_mcp/site"
|
||||
docs_dir = "src/personal_mcp/docs"
|
||||
|
||||
# The site_description is included in the HTML head and should contain a
|
||||
# meaningful description of the site content for use by search engines.
|
||||
#
|
||||
@@ -27,7 +30,7 @@ site_author = "<your name here>"
|
||||
# The site_url is the canonical URL for your site. When building online
|
||||
# documentation you should set this.
|
||||
# Read more: https://zensical.org/docs/setup/basics/#site_url
|
||||
#site_url = "https://www.example.com/"
|
||||
site_url = "https://mcp.john-stream.com/docs"
|
||||
|
||||
# The copyright notice appears in the page footer and can contain an HTML
|
||||
# fragment.
|
||||
@@ -44,114 +47,115 @@ Copyright © 2026 The authors
|
||||
# can be defined using TOML syntax.
|
||||
#
|
||||
# Read more: https://zensical.org/docs/setup/navigation/
|
||||
nav = [
|
||||
{ "Home" = "index.md" },
|
||||
{ "Guide" = [
|
||||
{ "Arch" = "architecture.md" },
|
||||
{ "Contracts" = [
|
||||
{ "Overview" = "contracts/index.md" },
|
||||
{ "Prompt" = "contracts/prompt.md" },
|
||||
{ "Skill" = "contracts/skill_contract.md" },
|
||||
{ "Frontmatter" = "contracts/frontmatter.md" },
|
||||
{ "URIs" = "contracts/uris.md" },
|
||||
] },
|
||||
{ "MCP" = "mcp_layout.md" },
|
||||
{ "Copilot" = "copilot.md" },
|
||||
{ "Usage" = "usage.md" },
|
||||
{ "Authoring" = "authoring.md" },
|
||||
{ "Future Work" = "future_work.md" },
|
||||
{ "Testing" = "testing.md" },
|
||||
{ "Security" = "securing.md" },
|
||||
] },
|
||||
{ "Prompts" = [
|
||||
{ "Authoring" = "prompts/authoring/PROMPT.md" },
|
||||
{ "JSFiddle Page Layout" = "prompts/jsfiddle-page-layout/PROMPT.md" },
|
||||
{ "NiceGUI Component Extraction" = "prompts/nicegui-component-extraction/PROMPT.md" },
|
||||
{ "Pytest Fill Scaffold" = "prompts/pytest-fill-scaffold/PROMPT.md" },
|
||||
{ "Pytest Scaffold" = "prompts/pytest-scaffold/PROMPT.md" },
|
||||
{ "Greenfield Architecture" = "prompts/greenfield-architecture/PROMPT.md" },
|
||||
{ "MCP Consumer Repo Shim" = "prompts/mcp-consumer-repo-shim/PROMPT.md" },
|
||||
] },
|
||||
{ "Skills" = [
|
||||
{ "Copilot" = [
|
||||
{ "Overview" = "skills/copilot-customization/SKILL.md" },
|
||||
{ "VS Code" = "skills/copilot-customization/references/vscode-customization.md" },
|
||||
] },
|
||||
{ "VS Code Config" = [
|
||||
{ "Overview" = "skills/vscode-configuration/SKILL.md" },
|
||||
{ "Debug Launch" = "skills/vscode-configuration/references/debug-launch-configurations.md" },
|
||||
{ "FastAPI Debug" = "skills/vscode-configuration/references/fastapi-debugpy-launch.md" },
|
||||
{ "Tasks" = "skills/vscode-configuration/references/tasks-json-configuration.md" },
|
||||
] },
|
||||
{ "FastAPI UV" = [
|
||||
{ "Overview" = "skills/fastapi-uv-docker/SKILL.md" },
|
||||
{ "Best" = "skills/fastapi-uv-docker/references/fastapi-best-practices.md" },
|
||||
{ "Layout" = "skills/fastapi-uv-docker/references/uv-project-layout.md" },
|
||||
{ "Uvicorn" = "skills/fastapi-uv-docker/references/uvicorn-settings.md" },
|
||||
{ "Docker" = "skills/fastapi-uv-docker/references/docker-cloud-native.md" },
|
||||
] },
|
||||
{ "Async SQLA" = [
|
||||
{ "Overview" = "skills/async-fastapi-sqlmodel/SKILL.md" },
|
||||
{ "Engine" = "skills/async-fastapi-sqlmodel/references/engine.md" },
|
||||
{ "Session" = "skills/async-fastapi-sqlmodel/references/session.md" },
|
||||
{ "FastAPI" = "skills/async-fastapi-sqlmodel/references/fastapi.md" },
|
||||
{ "Tx" = "skills/async-fastapi-sqlmodel/references/transactions.md" },
|
||||
{ "SQLModel" = "skills/async-fastapi-sqlmodel/references/sqlmodel.md" },
|
||||
{ "CRUD" = "skills/async-fastapi-sqlmodel/references/crud.md" },
|
||||
{ "Testing" = "skills/async-fastapi-sqlmodel/references/testing.md" },
|
||||
{ "IO" = "skills/async-fastapi-sqlmodel/references/implicit_io.md" },
|
||||
{ "Obs" = "skills/async-fastapi-sqlmodel/references/observability.md" },
|
||||
{ "Template" = "skills/async-fastapi-sqlmodel/references/template.md" },
|
||||
] },
|
||||
{ "NiceGUI" = [
|
||||
{ "Overview" = "skills/nicegui/SKILL.md" },
|
||||
{ "App Architecture" = "skills/nicegui/references/architecture.md" },
|
||||
{ "Startup" = "skills/nicegui/references/fastapi-uvicorn-startup.md" },
|
||||
{ "Visual Styling" = "skills/nicegui/references/styling-and-customization.md" },
|
||||
{ "Component Mechanics" = "skills/nicegui/references/component-mechanics-and-customization.md" },
|
||||
{ "Binding" = "skills/nicegui/references/binding-dataclasses.md" },
|
||||
{ "Flows" = "skills/nicegui/references/interaction-patterns.md" },
|
||||
{ "Quality" = "skills/nicegui/references/troubleshooting-and-quality-gates.md" },
|
||||
{ "Sources" = "skills/nicegui/references/source-documentation.md" },
|
||||
] },
|
||||
{ "Pytest" = [
|
||||
{ "Overview" = "skills/pytesting/SKILL.md" },
|
||||
{ "Docs" = "skills/pytesting/references/pytest-docs.md" },
|
||||
{ "AsyncIO" = "skills/pytesting/references/asyncio-testing.md" },
|
||||
] },
|
||||
{ "MCP Details" = [
|
||||
{ "Overview" = "skills/mcp-details/SKILL.md" },
|
||||
{ "Protocol" = "skills/mcp-details/references/mcp-protocol-and-spec.md" },
|
||||
{ "SDKs and FastMCP" = "skills/mcp-details/references/sdk-and-fastmcp.md" },
|
||||
{ "Ecosystem" = "skills/mcp-details/references/ecosystem-and-tooling.md" },
|
||||
] },
|
||||
{ "Logging" = [
|
||||
{ "Overview" = "skills/python-logging/SKILL.md" },
|
||||
{ "Docs" = "skills/python-logging/references/python-logging-docs.md" },
|
||||
{ "JSON File" = "skills/python-logging/references/json-file-logging.md" },
|
||||
{ "Network" = "skills/python-logging/references/network-logging-minimal-example.md" },
|
||||
{ "HTTPX" = "skills/python-logging/references/httpx-logging-handler-example.md" },
|
||||
] },
|
||||
{ "Pydantic Settings" = [
|
||||
{ "Overview" = "skills/pydantic-settings/SKILL.md" },
|
||||
{ "Source Docs" = "skills/pydantic-settings/references/source-documentation.md" },
|
||||
{ "Workflow" = "skills/pydantic-settings/references/implementation-workflow.md" },
|
||||
] },
|
||||
{ "Ruff" = [
|
||||
{ "Overview" = "skills/ruff-linting-formating/SKILL.md" },
|
||||
{ "Docs" = "skills/ruff-linting-formating/references/ruff-docs.md" },
|
||||
{ "Integrations" = "skills/ruff-linting-formating/references/ruff-integrations.md" },
|
||||
] },
|
||||
{ "Zensical" = [
|
||||
{ "Overview" = "skills/zensical-docs/SKILL.md" },
|
||||
{ "Features" = "skills/zensical-docs/references/zensical-features.md" },
|
||||
{ "Theme" = "skills/zensical-docs/references/theme-customization-and-icons.md" },
|
||||
{ "Quality" = "skills/zensical-docs/references/documentation-quality.md" },
|
||||
{ "IA" = "skills/zensical-docs/references/discoverability-and-ia.md" },
|
||||
{ "API Docs" = "skills/zensical-docs/references/code-heavy-docs-and-mkdocstrings.md" },
|
||||
] },
|
||||
] },
|
||||
]
|
||||
# nav = [
|
||||
# { "Home" = "index.md" },
|
||||
# { "Guide" = [
|
||||
# { "Arch" = "architecture.md" },
|
||||
# { "Contracts" = [
|
||||
# { "Overview" = "contracts/index.md" },
|
||||
# { "Prompt" = "contracts/prompt.md" },
|
||||
# { "Skill" = "contracts/skill_contract.md" },
|
||||
# { "Frontmatter" = "contracts/frontmatter.md" },
|
||||
# { "URIs" = "contracts/uris.md" },
|
||||
# ] },
|
||||
# { "MCP" = "mcp_layout.md" },
|
||||
# { "Copilot" = "copilot.md" },
|
||||
# { "Usage" = "usage.md" },
|
||||
# { "Authoring" = "authoring.md" },
|
||||
# { "Future Work" = "future_work.md" },
|
||||
# { "Testing" = "testing.md" },
|
||||
# { "Security" = "securing.md" },
|
||||
# ] },
|
||||
# { "Prompts" = [
|
||||
# { "Authoring" = "prompts/authoring/PROMPT.md" },
|
||||
# { "JSFiddle Page Layout" = "prompts/jsfiddle-page-layout/PROMPT.md" },
|
||||
# { "NiceGUI Component Extraction" = "prompts/nicegui-component-extraction/PROMPT.md" },
|
||||
# { "Pytest Fill Scaffold" = "prompts/pytest-fill-scaffold/PROMPT.md" },
|
||||
# { "Pytest Scaffold" = "prompts/pytest-scaffold/PROMPT.md" },
|
||||
# { "Greenfield Architecture" = "prompts/greenfield-architecture/PROMPT.md" },
|
||||
# { "MCP Consumer Repo Shim" = "prompts/mcp-consumer-repo-shim/PROMPT.md" },
|
||||
# ] },
|
||||
# { "Skills" = [
|
||||
# { "Copilot" = [
|
||||
# { "Overview" = "skills/copilot-customization/SKILL.md" },
|
||||
# { "VS Code" = "skills/copilot-customization/references/vscode-customization.md" },
|
||||
# ] },
|
||||
# { "VS Code Config" = [
|
||||
# { "Overview" = "skills/vscode-configuration/SKILL.md" },
|
||||
# { "Debug Launch" = "skills/vscode-configuration/references/debug-launch-configurations.md" },
|
||||
# { "FastAPI Debug" = "skills/vscode-configuration/references/fastapi-debugpy-launch.md" },
|
||||
# { "Tasks" = "skills/vscode-configuration/references/tasks-json-configuration.md" },
|
||||
# ] },
|
||||
# { "FastAPI UV" = [
|
||||
# { "Overview" = "skills/fastapi-uv-docker/SKILL.md" },
|
||||
# { "Best" = "skills/fastapi-uv-docker/references/fastapi-best-practices.md" },
|
||||
# { "Layout" = "skills/fastapi-uv-docker/references/uv-project-layout.md" },
|
||||
# { "Uvicorn" = "skills/fastapi-uv-docker/references/uvicorn-settings.md" },
|
||||
# { "Docker" = "skills/fastapi-uv-docker/references/docker-cloud-native.md" },
|
||||
# ] },
|
||||
# { "Async SQLA" = [
|
||||
# { "Overview" = "skills/async-fastapi-sqlmodel/SKILL.md" },
|
||||
# { "Engine" = "skills/async-fastapi-sqlmodel/references/engine.md" },
|
||||
# { "Session" = "skills/async-fastapi-sqlmodel/references/session.md" },
|
||||
# { "FastAPI" = "skills/async-fastapi-sqlmodel/references/fastapi.md" },
|
||||
# { "Tx" = "skills/async-fastapi-sqlmodel/references/transactions.md" },
|
||||
# { "SQLModel" = "skills/async-fastapi-sqlmodel/references/sqlmodel.md" },
|
||||
# { "CRUD" = "skills/async-fastapi-sqlmodel/references/crud.md" },
|
||||
# { "Testing" = "skills/async-fastapi-sqlmodel/references/testing.md" },
|
||||
# { "IO" = "skills/async-fastapi-sqlmodel/references/implicit_io.md" },
|
||||
# { "Obs" = "skills/async-fastapi-sqlmodel/references/observability.md" },
|
||||
# { "Template" = "skills/async-fastapi-sqlmodel/references/template.md" },
|
||||
# ] },
|
||||
# { "NiceGUI" = [
|
||||
# { "Overview" = "skills/nicegui/SKILL.md" },
|
||||
# { "App Architecture" = "skills/nicegui/references/architecture.md" },
|
||||
# { "Startup" = "skills/nicegui/references/fastapi-uvicorn-startup.md" },
|
||||
# { "Visual Styling" = "skills/nicegui/references/styling-and-customization.md" },
|
||||
# { "Component Mechanics" = "skills/nicegui/references/component-mechanics.md" },
|
||||
# { "Tables" = "skills/nicegui/references/tables.md" },
|
||||
# { "Binding" = "skills/nicegui/references/binding-dataclasses.md" },
|
||||
# { "Flows" = "skills/nicegui/references/interaction-patterns.md" },
|
||||
# { "Quality" = "skills/nicegui/references/troubleshooting-and-quality-gates.md" },
|
||||
# { "Sources" = "skills/nicegui/references/source-documentation.md" },
|
||||
# ] },
|
||||
# { "Pytest" = [
|
||||
# { "Overview" = "skills/pytesting/SKILL.md" },
|
||||
# { "Docs" = "skills/pytesting/references/pytest-docs.md" },
|
||||
# { "AsyncIO" = "skills/pytesting/references/asyncio-testing.md" },
|
||||
# ] },
|
||||
# { "MCP Details" = [
|
||||
# { "Overview" = "skills/mcp-details/SKILL.md" },
|
||||
# { "Protocol" = "skills/mcp-details/references/mcp-protocol-and-spec.md" },
|
||||
# { "SDKs and FastMCP" = "skills/mcp-details/references/sdk-and-fastmcp.md" },
|
||||
# { "Ecosystem" = "skills/mcp-details/references/ecosystem-and-tooling.md" },
|
||||
# ] },
|
||||
# { "Logging" = [
|
||||
# { "Overview" = "skills/python-logging/SKILL.md" },
|
||||
# { "Docs" = "skills/python-logging/references/python-logging-docs.md" },
|
||||
# { "JSON File" = "skills/python-logging/references/json-file-logging.md" },
|
||||
# { "Network" = "skills/python-logging/references/network-logging-minimal-example.md" },
|
||||
# { "HTTPX" = "skills/python-logging/references/httpx-logging-handler-example.md" },
|
||||
# ] },
|
||||
# { "Pydantic Settings" = [
|
||||
# { "Overview" = "skills/pydantic-settings/SKILL.md" },
|
||||
# { "Source Docs" = "skills/pydantic-settings/references/source-documentation.md" },
|
||||
# { "Workflow" = "skills/pydantic-settings/references/implementation-workflow.md" },
|
||||
# ] },
|
||||
# { "Ruff" = [
|
||||
# { "Overview" = "skills/ruff-linting-formating/SKILL.md" },
|
||||
# { "Docs" = "skills/ruff-linting-formating/references/ruff-docs.md" },
|
||||
# { "Integrations" = "skills/ruff-linting-formating/references/ruff-integrations.md" },
|
||||
# ] },
|
||||
# { "Zensical" = [
|
||||
# { "Overview" = "skills/zensical-docs/SKILL.md" },
|
||||
# { "Features" = "skills/zensical-docs/references/zensical-features.md" },
|
||||
# { "Theme" = "skills/zensical-docs/references/theme-customization-and-icons.md" },
|
||||
# { "Quality" = "skills/zensical-docs/references/documentation-quality.md" },
|
||||
# { "IA" = "skills/zensical-docs/references/discoverability-and-ia.md" },
|
||||
# { "API Docs" = "skills/zensical-docs/references/code-heavy-docs-and-mkdocstrings.md" },
|
||||
# ] },
|
||||
# ] },
|
||||
# ]
|
||||
|
||||
# With the "extra_css" option you can add your own CSS styling to customize
|
||||
# your Zensical project according to your needs. You can add any number of
|
||||
@@ -441,6 +445,7 @@ anchor_linenums = true
|
||||
line_spans = "__span"
|
||||
pygments_lang_class = true
|
||||
[project.markdown_extensions.pymdownx.inlinehilite]
|
||||
[project.markdown_extensions.pymdownx.snippets]
|
||||
[project.markdown_extensions.pymdownx.keys]
|
||||
[project.markdown_extensions.pymdownx.magiclink]
|
||||
[project.markdown_extensions.pymdownx.mark]
|
||||
|
||||
Reference in New Issue
Block a user