kata-docs-serve

What problem does it solve?

It helps you preview and navigate Markdown documentation locally by turning the docs/ directory into a searchable, browsable website.

Core Features & Use Cases

• Installs and validates MkDocs: Checks that MkDocs is available and installs MkDocs Material when missing.
• Resolves docs_dir automatically: Derives the correct docs directory from Ahrena directives (domain, oas, events) or uses docs/ as a safe default.
• Bootstraps configuration when needed: Generates a minimal mkdocs.yml at the repo root if one does not exist, without overwriting existing configuration.
• Runs hot-reloading preview: Starts a local server that refreshes when Markdown files change, supporting fast iteration during documentation development.
• Use case: You are actively writing docs for a platform feature and want immediate feedback on sidebar navigation and search behavior without deploying to a hosted environment.

Quick Start

Run the kata to serve your local documentation with MkDocs, automatically using the correct docs_dir and generating mkdocs.yml if it is missing.