Repository navigation
Conversation
User documentation now lives in docs/ as its own component: Sphinx with Markdown (MyST) and the Furo theme, one guide per role. The first page explains the hackathon owner's Settings page — the phase marker opens nothing on its own, what each capability switch allows (checked against the backend handlers and casbin rules), and tracks. `just docs::build` builds it like CI will; `just docs::serve` previews it with live reload. The existing hackagon::doc-sphinx runner now fails on any Sphinx warning, so a broken link cannot be merged, and syncs the venv from uv.lock on every run instead of only when the venv is missing.
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.
Documentation on how the platform works is needed and important.