Skip to content

chore: local doc build instructions#144

Merged
dnywh merged 4 commits intomainfrom
dnywh/chore/local-instructions
Feb 15, 2026
Merged

chore: local doc build instructions#144
dnywh merged 4 commits intomainfrom
dnywh/chore/local-instructions

Conversation

@dnywh
Copy link
Contributor

@dnywh dnywh commented Feb 13, 2026

What is the current behavior?

  • Missing build instructions for building documentation locally for frontend
  • Old logo
  • Remote links for elephant image

What is the new behavior?

  • Added instructions to README for building docs locally
  • Updated Supabase logo
  • Referenced new local elephant image
  • Version bumps for pre-commit checks

Summary by CodeRabbit

  • Documentation

    • Added a "Building the docs locally" section with virtualenv, dependency, serve (live-reload) and build instructions.
    • Replaced external header and theme images with local assets (including favicon/logo) for more reliable, offline-friendly docs.
    • Minor formatting cleanups around code blocks.
  • Chores

    • Bumped CI/tooling to Python 3.12 and updated related workflow and formatter configurations.

@dnywh dnywh requested a review from olirice February 13, 2026 00:57
@coderabbitai
Copy link

coderabbitai bot commented Feb 13, 2026

📝 Walkthrough

Walkthrough

Replaced external header/index images with local docs assets, added "Building the docs locally" instructions to README.md (MkDocs Material, venv, install, mkdocs serve/mkdocs build), updated mkdocs.yaml to use PNG favicon/logo, and bumped Python to 3.12 in CI and pre-commit config.

Changes

Cohort / File(s) Summary
Docs — README & site
README.md, docs/index.md
Replaced external header/index images with local docs assets; README.md adds "Building the docs locally" section (virtualenv, dependencies, mkdocs serve at http://127.0.0.1:8000 with live reload, mkdocs build) and minor formatting adjustments.
Config — MkDocs
mkdocs.yaml
Changed theme resource references from favicon.icofavicon.png and logo.icologo.png.
CI / Workflows
.github/workflows/pre-commit_hooks.yaml
Bumped GitHub Actions versions: actions/checkout@v2@v4, actions/setup-python@v1@v5; updated Python version and step name from 3.9 to 3.12.
Pre-commit Config
.pre-commit-config.yaml
Updated Black hook language_version from python3.9 to python3.12.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main changes: adding local doc build instructions in README.md and related documentation setup (MkDocs configuration, Python version updates, docs images).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dnywh/chore/local-instructions

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Fix all issues with AI agents
In `@mkdocs.yaml`:
- Around line 30-31: The mkdocs config currently sets logo to the same asset as
favicon (keys: favicon and logo), so replace the logo value with the distinct
logo asset (e.g., change logo: 'assets/favicon.png' to the actual logo path like
'assets/logo.png') or remove the logo key if no separate logo exists; update the
logo key in mkdocs.yaml to point to the correct image file so the site shows the
intended logo.

In `@README.md`:
- Line 3: The header image tag (<img src="docs/assets/splinter-elephant.png"
height="250">) is missing an alt attribute which fails MD045 and hurts
accessibility; update the <img> element in README.md to include a meaningful alt
text (e.g., alt="Splinter Elephant logo" or a short descriptive phrase) so the
tag becomes <img ... alt="...">, ensuring the alt text succinctly describes the
image for screen readers.
- Around line 62-71: The README shows using "mkdocs serve" and "mkdocs build"
but the repo uses mkdocs.yaml (not the mkdocs.yml default), so update the
commands in README.md to either reference the config explicitly or instruct
renaming the file: change "mkdocs serve" to "mkdocs serve -f mkdocs.yaml" and
"mkdocs build" to "mkdocs build -f mkdocs.yaml", or alternatively rename
mkdocs.yaml to mkdocs.yml and keep the original commands; edit the lines
containing the mkdocs commands accordingly.

@dnywh dnywh force-pushed the dnywh/chore/local-instructions branch from 606058d to cf8ac69 Compare February 13, 2026 01:17
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Python 3.9 is no longer available on GitHub’s runners, so the pre-commit workflow fails.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In @.github/workflows/pre-commit_hooks.yaml:
- Around line 14-17: Replace the deprecated GitHub Action reference
`actions/setup-python@v1` with the current stable `actions/setup-python@v5` and
keep `python-version: 3.12` intact so the runner uses Python 3.12; while editing
the workflow also update `actions/checkout@v2` to `actions/checkout@v4` to use
the supported checkout action. Ensure the `uses:` entries in the job steps are
updated exactly (e.g., `uses: actions/setup-python@v5` and `uses:
actions/checkout@v4`) and run the workflow lint/CI to verify there are no
compatibility issues.

@dnywh dnywh merged commit b9de3a3 into main Feb 15, 2026
3 checks passed
@dnywh dnywh deleted the dnywh/chore/local-instructions branch February 16, 2026 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants