Promote staging to production - #26
Conversation
* docs: fix DDD sentence line break * docs: remove unintended rendered line breaks
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughDocumentation across product, engineering, lifecycle, experience, and site materials was reformatted and selectively clarified. The build script now runs a new validator that detects unexpected ChangesDocumentation and validation
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
scripts/check-rendered-line-breaks.mjs (1)
5-5: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick winHero allowlist regex is asymmetric/order-dependent;
<br>search may miss self-closing variants.The light-image match requires
docslime-hero-wordmark-light"to be the last class token before the closing quote, while the dark-image match ([^>]*docslime-hero-wordmark-dark) matches the class anywhere in the tag. If the renderer ever reorders/appends classes on the light<img>, this allowlist silently stops matching and the build starts failing on the intentional hero break. Separately, the scan only looks for literal<br>(Line 20); a self-closing<br />from the renderer would go undetected, defeating the check's purpose.♻️ Suggested more robust attribute match
-const allowedHeroBreak = /docslime-hero-wordmark-light"[^>]*><br>\s*<img[^>]*docslime-hero-wordmark-dark/g; +const allowedHeroBreak = /class="[^"]*\bdocslime-hero-wordmark-light\b[^"]*"[^>]*>\s*<br\s*\/?>\s*<img[^>]*docslime-hero-wordmark-dark/g;- const unexpectedBreaks = html.replace(allowedHeroBreak, "").match(/<br>/g)?.length ?? 0; + const unexpectedBreaks = html.replace(allowedHeroBreak, "").match(/<br\s*\/?>/g)?.length ?? 0;Please confirm what the actual docmd-rendered hero markup and line-break output look like to validate whether this matters in practice.
Also applies to: 20-20
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@scripts/check-rendered-line-breaks.mjs` at line 5, Update allowedHeroBreak and the line-break scan in the rendered-markup check to match the hero light class regardless of its position among class tokens and to recognize both `<br>` and self-closing `<br />` forms. Verify the patterns against the actual docmd-rendered hero markup and line-break output, preserving the intentional hero-break allowlist behavior.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/engineering/adrs/README.md`:
- Around line 7-9: Update the fenced command block in the ADR README to declare
the shell language as sh, preserving the existing command content.
---
Nitpick comments:
In `@scripts/check-rendered-line-breaks.mjs`:
- Line 5: Update allowedHeroBreak and the line-break scan in the rendered-markup
check to match the hero light class regardless of its position among class
tokens and to recognize both `<br>` and self-closing `<br />` forms. Verify the
patterns against the actual docmd-rendered hero markup and line-break output,
preserving the intentional hero-break allowlist behavior.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 39d65022-4aba-4751-9323-92184b925fdd
📒 Files selected for processing (18)
docs/DESIGN.mddocs/PRODUCT.mddocs/README.mddocs/REQUIREMENTS.mddocs/engineering/ARCHITECTURE.mddocs/engineering/OBSERVABILITY.mddocs/engineering/PUBLISHING.mddocs/engineering/README.mddocs/engineering/TESTING.mddocs/engineering/adrs/0001-embed-templates-in-binary.mddocs/engineering/adrs/README.mddocs/experience/README.mddocs/index.mddocs/lifecycle.mddocs/skills.mddocs/strategy/README.mdpackage.jsonscripts/check-rendered-line-breaks.mjs
| ``` | ||
| docslime add adr <short-slug> | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Specify a language for the fenced command block.
Line [7] starts a fenced block without a language, triggering MD040. Mark this command block as sh.
Proposed fix
-```
+```sh
docslime add adr <short-slug></details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 7-7: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/engineering/adrs/README.md` around lines 7 - 9, Update the fenced
command block in the ADR README to declare the shell language as sh, preserving
the existing command content.
Source: Linters/SAST tools
1 participant
Release inventory
<br>elements.Included PR
Local gates
cargo fmt --checkcargo test(23 passed)cargo clippy --all-targets -- -D warningsnpm cinpm run build(16 pages; rendered-line-break guard passed)git diff --checkRisk and caveats
Production smoke plan
maincommit.<br>elements, allowing only the intentional hero wordmark transition.<br>.Note
Add post-build check for unintended line breaks in rendered documentation
buildnpm script in package.json so it runs automatically afterdocmd build.Macroscope summarized dba132b.
Summary by CodeRabbit
Documentation
Quality Improvements