docs: site polish — Features, Troubleshooting, config restructure, slim README (recovers stranded #123 work)#125
Merged
Conversation
…im README Recovers the docs work stranded when PR #123 squash-merged at a stale head (a GitHub PR-head-sync glitch left only the first commit, the How it works page, in main). This carries the remaining changes on top of current main: - Features page (docs/features.md) + Highlighted-features rename and full-list link on the Overview. - Troubleshooting page (docs/troubleshooting.md); host/infra block trimmed out of operate.md. - Configuration reference restructured into per-[section] tables + example TOML, documents [mcp_server], adds a quick-start config; feature deep-dives preserved verbatim. - Self-hosted / in-house OpenAI-compatible model recipe (recipes.md). - Nav: Run/MCP/GitHub Action nested under Install and configure (navigation.indexes); Examples and References excluded from the site (source kept). - README slimmed to a git-level front door that defers to the docs site.
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
1 participant
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.
Why this exists: PR #123 squash-merged at a stale head (a GitHub PR-head-sync glitch left the PR pointer on the first commit), so only the How it works page reached
main. The other 8 commits' work was stranded on the branch. This PR carries that work on top of currentmain, as one clean commit.Docs-only; no application code.
how-it-works.mdis already inmainand is untouched here.docs/features.md) + "Highlighted features" rename and a View full list link on the Overview.docs/troubleshooting.md); host/infra block trimmed out ofoperate.md.[section], documents the previously-missing[mcp_server], adds a copy-paste quick-start config; the six feature deep-dives are preserved verbatim (anchors intact).recipes.md).navigation.indexes); Examples and References excluded from the published site (source kept in-repo).Verification
mkdocs build --strict— clean; anchors, nav nesting, and cross-links resolvecz checkpasses; docs-only, no release-triggering commits