Skip to content

Redesign README around the real floor plan - #41

Merged
miles-howell merged 2 commits into
mainfrom
claude/focused-einstein-ljfxip
Oct 28, 2026
Merged

miles-howell merged 2 commits into
mainfrom
claude/focused-einstein-ljfxip

Conversation

@miles-howell

Copy link
Copy Markdown
Owner

Summary

Redesigns the repository homepage using the beautify-github-readme skill, which this PR also adds under .claude/skills/.

README

  • Hero (assets/readme/hero.svg): a mini map of the real 13×30 layout from floorplan_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.
  • Proof (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.
  • Admin console (assets/readme/admin-console.png): Layout mode with cells selected.
  • New order: what it is → screenshots → how it works → quick start → admin → API → configuration → development → license. It's shorter overall (+50 / −72 lines).
  • assets/readme/source/build_hero.py redraws the hero from the fixture when the layout changes.

Corrections (checked against the code)

  • The env var is SECRET_KEY, not DJANGO_SECRET_KEY.
  • ALLOWED_HOSTS is hardcoded in settings, not read from the environment.
  • The requirements are Django 6.1 / Python 3.12+, and the license is Apache-2.0.
  • Removed the sample_floorplan.json step: that fixture fails to load on a fresh database because its desks have no row_index. The fixture itself is unchanged.
  • Replaced the "enter your name in the sidebar" flow, which the template no longer has, with the actual Reserve-dialog flow.

Skill

  • .claude/skills/beautify-github-readme/ is vendored from oil-oil/beautify-github-readme at commit d6562a5, under the MIT license (included).

Testing

  • python manage.py test passes.
  • The skill's audit_readme.py passed: image references and SVG basics are OK.
  • Previewed locally at 900px in light and dark mode and at mobile width.

Not addressed

  • With 21 active assignments loaded, the admin console's "Active Assignments" panel showed "No active assignments at this time." I haven't investigated; it may be worth a separate issue.

Generated by Claude Code

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
@github-actions

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@miles-howell
miles-howell merged commit 2ca808b into main Oct 28, 2026
3 checks passed
@miles-howell
miles-howell deleted the claude/focused-einstein-ljfxip branch October 28, 2026 20:43
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