Skip to content

Correct the PR preview docs and cover what was missing - #102

Merged
AdamXweb merged 1 commit into
mainfrom
docs/pr-preview-accuracy
Nov 10, 2026
Merged

AdamXweb merged 1 commit into
mainfrom
docs/pr-preview-accuracy

Conversation

@adamXbot

Copy link
Copy Markdown
Collaborator

What changed

The PR preview documentation now matches what the generated workflows do. This is a docs-only change.

Corrected

  • The list of three preview workflows was split by a paragraph, which broke the numbering.
  • The README said the Firefox watch reads the same FXCSS_OLDEST_FIREFOX setting. firefox-watch.yml has its own copy, so the two can differ.
  • The comment opens with the Firefox support result only when that setting is not empty.
  • New variants are included automatically only when FXCSS_VARIANTS does not name specific stylesheets.
  • examples/README.md described a per-theme variant allowlist. The publish workflow now uses a strict name pattern, so later stylesheets need no hand-editing.

Added

  • A "What the comment shows" section: grouped changes, new and missing views, views not compared, failed validation, and the fallback for very long comments.
  • The comment is published only when all three platforms render successfully, and how to publish by hand when one fails.
  • A FXCSS_VIEWS pattern that matches none of a runner's captures fails that platform's render job.
  • a+b combinations in FXCSS_VARIANTS.
  • init refuses named editions and themes that need --entry.
  • An "Updating generated workflows" section. --force replaces only the workflows the command names, and settings you do not pass return to their defaults.

Why

The features added since 0.24 were mostly documented, but some statements were wrong and several behaviours a maintainer would run into were not written down.

Notes for reviewers

  • Previews on all repository changes need 0.26.0, which the README now says alongside the layout changes.
  • fxcss.com is generated from this README and refreshes only for a version PyPI serves, so these changes appear there once 0.26.0 is published.
  • The comment behaviour and the manual publish command were checked against the workflow templates, not on a live pull request.

Testing

  • python -m unittest tests.test_workflows tests.test_flag_columns tests.test_release_orchestration: 59 tests pass.
  • fxcss init in a disposable repository: all six workflows, rejected settings, empty values, plain --force and a nested theme, each behaving as documented.
  • Every internal README link resolves to a heading.

🤖 Generated with Claude Code

Several statements about PR previews no longer matched the generated
workflows, and behaviour added since 0.24 was undocumented.

Fix the broken workflow list, the claim that the Firefox watch shares the
preview's setting, and the examples page's description of the publish
allowlist. Document what the comment shows, when it is not published and how
to publish by hand, and how to regenerate existing workflows safely.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@AdamXweb
AdamXweb merged commit eb7a4b6 into main Nov 10, 2026
20 checks passed
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