Add GitHub Pages docs site and Ask AI affordances#61
Closed
Gsbreddy wants to merge 1 commit into
Closed
Conversation
- Add MkDocs Material config, docs landing page, and pinned docs/requirements.txt - Deploy site/ to Pages on main via actions/upload-pages-artifact + deploy-pages - Perplexity/ChatGPT banner, floating Ask AI (Perplexity), extra CSS - Ignore local site/; document preview in DEVELOPMENT and Pages setup in CONTRIBUTING - Link published docs from README and pyproject Documentation URL Co-authored-by: Gottam Sai Bharath <Gsbreddy@users.noreply.github.com>
7 tasks
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
2 participants
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 MkDocs Material site for the existing
docs/guides, a GitHub Actions workflow that builds and deploys it to GitHub Pages on pushes tomain, and lightweight “Ask AI” entry points (dismissible banner plus a floating Perplexity shortcut) that do not call FlightDeck infrastructure.Why
Keeps long-form documentation on a stable public URL while staying in sync with the repository, and gives readers a quick way to open an external assistant with repo and docs context.
Changes
mkdocs.yml,docs/index.md,docs/requirements.txt, and smalldocs/stylesheets/extra.css+docs/javascripts/ask-ai.js..github/workflows/pages.ymlusingactions/upload-pages-artifactandactions/deploy-pages.pyproject.toml(DocumentationURL),DEVELOPMENT.md, andCONTRIBUTING.mdupdated;CHANGELOG.mdunder Unreleased;.gitignorefor localsite/.validation.linksignores targets outsidedocs/so../SECURITY.md-style links (for GitHub readers) do not failmkdocs build --strict.Validation
pip install -r docs/requirements.txtandmkdocs build --strictuv sync --frozen --extra dev,uv run python -m ruff check src tests,uv run python -m pytest(139 passed, 4 skipped)Schema / Storage Impact
Risk
Low: additive workflow and docs tooling only. Maintainers must set Settings → Pages → Source: GitHub Actions once if Pages was not already configured for Actions-based deploys.
Review
@flightdeckdev/maintainersas appropriate.