Repository navigation
Redesign README around the real floor plan - #41
Merged
Merged
Conversation
Vendored from https://github.com/oil-oil/beautify-github-readme (commit d6562a5, MIT). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AuQsGwQgAUSgfsTiDkTMUM
README.md: new hero, real app screenshots, and a shorter value -> proof -> how it works -> quick start order. Corrects setup details against the code: SECRET_KEY (not DJANGO_SECRET_KEY), hardcoded ALLOWED_HOSTS, Django 6.1 / Python 3.12+, Apache-2.0, and drops the sample_floorplan.json step, which no longer loads on a fresh database. Replaces the removed sidebar name lookup with the actual reserve-dialog flow. assets/readme/: hero.svg generated from floorplan_layout.json by source/build_hero.py, plus floor-plan.png and admin-console.png captured from the running app with demo assignments. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AuQsGwQgAUSgfsTiDkTMUM
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
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.
Summary
Redesigns the repository homepage using the
beautify-github-readmeskill, which this PR also adds under.claude/skills/.README
assets/readme/hero.svg): a mini map of the real 13×30 layout fromfloorplan_layout.json, in the department colours, with one desk called out by its real identifier format (enrollment-r13c10). It has its own background, so it reads the same in light and dark mode.assets/readme/floor-plan.png): screenshots of the running app showing the full grid, a desk detail dialog and the Reserve dialog. The caption says the assignments are demo data.assets/readme/admin-console.png): Layout mode with cells selected.assets/readme/source/build_hero.pyredraws the hero from the fixture when the layout changes.Corrections (checked against the code)
SECRET_KEY, notDJANGO_SECRET_KEY.ALLOWED_HOSTSis hardcoded in settings, not read from the environment.sample_floorplan.jsonstep: that fixture fails to load on a fresh database because its desks have norow_index. The fixture itself is unchanged.Skill
.claude/skills/beautify-github-readme/is vendored from oil-oil/beautify-github-readme at commitd6562a5, under the MIT license (included).Testing
python manage.py testpasses.audit_readme.pypassed: image references and SVG basics are OK.Not addressed
Generated by Claude Code