Repository navigation
docs: fix table and code rendering, and document the Action's and App's AI settings - #92
Merged
Merged
Conversation
…'s AI settings
- Table code no longer splits mid-word (Sumi's overflow-wrap: anywhere) and
code blocks no longer draw != as a ligature.
- Drop Material-only syntax Sumi prints as text: { .lg .middle } on the
getting-started cards and the # (1) code annotations.
- Close the GitLab list that ran into a paragraph after its code block.
- Action guide: add message-ai-attribution, pr-body-ai-attribution and
ai-label; pr-title now describes what --pr-title checks.
- App guide: CC017 and CC501 are checked; document body_ai_attribution,
ai_label and require_verified.
- Configuration: list inherit_from, warn, the App's [pull_request] settings
and [jira].
- Command-line recipes: check a pull request title with --pr-title.
- Home page: a menu button and navigation drawer on phones.
✅ Deploy Preview for commit-check ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 53 minutes. View limit details
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. |
shenxianpeng
added a commit
that referenced
this pull request
Nov 19, 2026
Sumi 0.4.1 fixes the three theme problems that #92 worked around on the site side. This bumps the theme and removes those workarounds. | Sumi 0.3.1 problem | Workaround in #92 | Now | |---|---|---| | Inline code in tables broke mid-word (`overflow-wrap: anywhere`) | `td code, th code { overflow-wrap: break-word }` in `extra.css` | removed; Sumi does it | | Code blocks drew `!=` as ≠ (the `font` shorthand reset ligatures) | ligature rule for `.sumi-prose pre` in `extra.css` | removed; Sumi does it | | No phone menu on a landing page without navigation tabs | hand-made `<aside>` drawer in `landing.html`, `layout: docs` in `index.md`, a hide rule in `landing.css` | `landing.html` includes Sumi's `partials/sidebar.html`, which 0.4.1 renders as a drawer only; `index.md` keeps Sumi's landing layout | One small addition: with the landing layout, Sumi narrows the header and footer to 1200px. `landing.css` keeps them at the 1220px column the page already uses, so the home page looks the same as before. ### Before vs after - Home page at 1440px, full page: pixel-identical to the live site (screenshots compared with reduced motion so the demo animation holds still). - Home page at 390px: same as the live site apart from text antialiasing. The menu button shows, and the drawer slides in with the full navigation: <img src="https://github.com/commit-check/commit-check.com/raw/e87c1a0fe5b28974f16b265fa796c75717a6b358/.pr-images/phone-menu-0.4.1.png" width="300" alt="Home page on a phone with the navigation drawer open"> - Mid-word breaks in table code on all 31 pages: 0 at 1280px and 0 at 390px, the same as with the workaround. - Code block on the Configuration page: computed `font-variant-ligatures: none`. - At 1440px the drawer is hidden and the menu button is not shown. No page scrolls sideways. ### Checks - `mkdocs build --strict` passes. - `pytest tests` passes (18). <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## Summary by CodeRabbit * **Documentation** * Updated the landing page navigation to use a phone-drawer sidebar. * **Style** * Adjusted landing-page header and footer content to align with the page width and spacing. * Removed custom code-block ligature and inline-code wrapping rules. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com>
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.
Before: on the live site, inline code in tables splits mid-word (the Action guide shows
messag/e), code blocks draw!=as≠, Material-only syntax shows up as text ({ .lg .middle },# (1)), the GitLab guide's last bullet runs into a paragraph, and the home page has no menu on a phone. The Action guide lists 9 of the Action's 12 inputs and describespr-titleas a Conventional Commits check; the App guide says the App runs CC001–CC016 and does not mentionbody_ai_attribution,ai_labelorrequire_verified.After:
Each image: Before on the left, After on the right.
GitHub Action, Inputs
GitLab guide:
!=and the last bulletGetting started, step 5
Getting started, step 6
Home page on a phone, menu opened
What changed:
assets/extra.css: table code wraps withoverflow-wrap: break-wordinstead of Sumi'sanywhere, which shrank the column to one character; code blocks turn ligatures off again after Sumi'sfontshorthand on.sumi-prose prereset them. Placed away from the lines the layout PR (docs: widen the docs column and wrap long lines instead of scrolling #91) changes.getting-started.md,guides/github-actions.md: plain comments instead of# (1)annotations; no{ .lg .middle }on the cards.guides/other-ci.md: blank line after the nested code block, so the list continues.guides/github-actions.md: rows formessage-ai-attribution,pr-body-ai-attributionandai-label(from action.yml and the Action README);pr-titlesays what--pr-titlechecks; theeditedtip covers the description too.guides/github-app.md: CC001–CC017 plus CC501; new sections "AI-written pull requests" and "Verified commits", taken from the App README.configuration.md: a "Top level" table (inherit_from,warn),body_ai_attributionandai_labelunder[pull_request], a[jira]table, and a note onrequire_verifiedunder[commit]. The App-only rows sit outside the sectionsdocs_sync_testcompares with the CLI.example.md: a "Checking a pull request title" recipe (output from 2.22.0), and the skipped-check warning points at--pr-title.index.md,overrides/landing.html,stylesheets/landing.css: the home page setslayout: docs, so Sumi keeps its menu button, and renders the sidebar as the phone drawer; it stays hidden above 920px. The desktop home page is unchanged (pixel diff only in the animated demo).How:
mkdocs build --strictis clean andpython -m pytest tests/ -qpasses (18) against commit-check 2.22.0. A Playwright scan of all 31 pages found 32 table code spans broken mid-word on the live site at 1280px, and 0 on this build at 1280px and 390px.