docs: add usage and developer documentation#105
Merged
Conversation
jmagly
marked this pull request as ready for review
July 20, 2026 16:44
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a documentation base for users and developers, plus Pagenary docsite publishing support:
docs/GETTING_STARTED.mdfor install, configuration, first safe run, CLI basics, updates, and troubleshootingdocs/README.mdas the docs landing pagedocs/DEVELOPER_GUIDE.mdfor source layout, development commands, SDK usage, extension points, and docsite workflowdocs/API_REFERENCE.mdwith the current local HTTP route surface grouped by workflowdocs/MCP_GUIDE.mdfor the stdio MCP server andsecurity_recondocsite/t3mp3st-docs/Pagenary tenant source with config, manifest, generated content pages, and page metadatatenants.jsonregistry for Pagenary publishingCloses #102
Pagenary workflow
npm run docs:syncregenerates the Pagenary tenant source from canonical Markdown docsnpm run docs:buildbuilds the static Pagenary docsitenpm run docs:checkverifies generated publishing artifacts and indexed page coveragenpm run docs:servebuilds and serves the docsite locally at/t3mp3st-docs/PAGENARY_SITE_URLcan override the canonical production URL during docsite generationValidation
git diff --checknpm installnpm run docs:checknpm run buildnpm testhttp://127.0.0.1:5173/t3mp3st-docs/src/server.tsare referenced indocs/API_REFERENCE.mdNote: Playwright browser inspection could not run in this environment because the local Playwright browser extension was unavailable, so docsite preview verification used Pagenary build/check output plus HTTP smoke checks.