docs: add user-friendly Furo documentation site - #98
Closed
kiro-agent[bot] wants to merge 6 commits into
Closed
Conversation
Co-authored-by: Karan Adhikari <113664541+weebzone@users.noreply.github.com>
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.
This pull request was created by @kiro-agent on behalf of @weebzone 👻
Comment with /kiro fix to address specific feedback or /kiro all to address everything.
Learn about Kiro Web
Summary
Adds a complete, beginner-friendly documentation site under
docs/, built with Sphinx + the Furo theme and written in MyST Markdown. Content is split into multiple navigable pages (like FastAPI/Docker docs) instead of one giant README, and written in layman's terms with Beginner Tip / Common Mistake / Recommended / Good to Know callout boxes throughout.All content is derived from a full scan of the codebase, so it accurately reflects real behavior (filename parsing, split/combined files, manual entry, auto-catalog rules, config variables, streaming, API endpoints, themes, deployment).
Pages included
Notable accurate details documented
.ext.NN) grouping and combined-episode / season-pack handling.config.envstartup vars vs. runtime web-panel settings.How it was tested
sphinx-build -b html -W --keep-going(warnings treated as errors) — build succeeds with zero warnings._build/) and the local.venv/are git-ignored.How to build/preview
Notes / follow-ups
docs/_static/later.