Skip to content

docs(calendar): replace the ASCII mock-ups with real renders - #389

Open
ChuckBuilds wants to merge 1 commit into
mainfrom
docs/calendar-readme
Open

docs(calendar): replace the ASCII mock-ups with real renders#389
ChuckBuilds wants to merge 1 commit into
mainfrom
docs/calendar-readme

Conversation

@ChuckBuilds

Copy link
Copy Markdown
Owner

What changed

The README explained the display with three hand-drawn sketches:

    03/15 2:30pm

    Team Meeting

Those are now real plugin output at the true panel size, covering the four screens the plugin can show — a timed event, an all-day event, a long title being ellipsized, and the empty state — plus a panel-size sheet.

The long-title render is the interesting one: it confirms the ellipsis behaviour the code comment describes, where a title that wrapped past the visible lines ends Rev... rather than just stopping.

Settings

google_auth was the one setting the configuration reference did not mention. It is not a value you type — it is the web UI's Connect Your Google Account button (x-widget: google-oauth), and the entry now says so and points at the consent flow already documented above it.

The two combined customization.* rows are split so each key has its own line. That takes the plugin to 13 of 13 settings documented by key; the config-token audit drops nothing.

Also verified: the README's manager.py:346-348 reference to InstalledAppFlow.run_local_server() still points at the right code (it is at line 347).

A note on the tooling diff

Rendering these needed the shots attrs seam — runtime state applied to the plugin instance after the loader builds it, since this plugin's events arrive from Google rather than from configuration. That seam is in #386 and not on main yet, so the identical change to sitecustomize.py and render_docs_assets.py is included here to let this branch render on its own. Whichever merges first, the other's copy of those two files should apply cleanly.

Checks

  • check_plugin.py: 8/8 pass
  • render_docs_assets.py --check: both composites and the hero reproduce
  • Section-list diff: only the three ASCII sub-sections are gone, their content preserved as bullets beside the images

Docs only. 1.2.3 → 1.2.4.

🤖 Generated with Claude Code

The README described the display with three hand-drawn text sketches:

      03/15 2:30pm

      Team Meeting

They are now real plugin output at the true panel size -- a timed event, an
all-day event, a long title being ellipsized, and the empty state -- plus a
panel-size sheet.

Also documents google_auth, the one setting the reference did not mention. It
is not a value you type: it is the web UI's "Connect Your Google Account"
button (x-widget: google-oauth). The two combined customization rows are split
so each key appears on its own, which takes the plugin to 13 of 13 settings
documented by key.

Rendering these needed the shots "attrs" seam from #386, which is not on main
yet; the identical change to sitecustomize.py and render_docs_assets.py is
included here so this branch can render on its own.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: 830b5246-36ee-40e9-9a28-c0f1072d7756


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 17 complexity

Metric Results
Complexity 17

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

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.

1 participant