Skip to content

Commit 2f0b077

Browse files
ihabadhamclaude
andauthored
fix: format stray markdown files and correct broken link breaking CI on main (#3301)
## Summary Two markdown files were merged to `main` without passing the repo-wide checks, which turns `markdown-format-check` and the `build` job's format step **red on every open PR** (both run `prettier --check` over the entire repo, not just changed files): - `internal/planning/json-render-body-migration-plan.md` (from #3299) — prettier formatting only. - `reports/ror-memory-leakage-investigation.md` (from #3296) — prettier formatting **and** a relative link to `../../docs/pro/js-memory-leaks.md`, which is one level too high and resolves outside the repo. The target exists at repo-root `docs/pro/js-memory-leaks.md`; corrected to `../docs/pro/js-memory-leaks.md`. Formatting changes are `prettier --write` output only (no content edits). The link change is a single relative-path correction; verified the target file exists and the `markdown-links` (lychee) pre-commit hook now passes. ## Why this is its own PR These files are unrelated to any feature work, but their CI failures block unrelated PRs (e.g. #3232). Fixing them on `main` directly via a focused PR unblocks everything in flight. ## Test plan - `pnpm exec prettier --check internal/planning/json-render-body-migration-plan.md reports/ror-memory-leakage-investigation.md` → clean - `markdown-links` lefthook hook passes (corrected link resolves) - No content changes beyond the one relative-path fix 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated planning documentation with status updates for related pull requests and issue tracking * Enhanced investigation report with improved structure and readability through reformatted content into consistent table formats <!-- review_stack_entry_start --> [![Review Change Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/shakacode/react_on_rails/pull/3301) <!-- review_stack_entry_end --> <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent fd9feb5 commit 2f0b077

2 files changed

Lines changed: 131 additions & 122 deletions

File tree

internal/planning/json-render-body-migration-plan.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ implementation still needs. It is not itself the implementation.
99

1010
## Links
1111

12-
| Artifact | Location |
13-
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
14-
| Issue | https://github.com/shakacode/react_on_rails/issues/3280 |
15-
| Experiment PR (the "demo") — **closed** | [#3293](https://github.com/shakacode/react_on_rails/pull/3293) (closed; experiment fully captured in this doc — see note below) |
16-
| Experiment commit (react_on_rails) | [`352743ef1`](https://github.com/shakacode/react_on_rails/commit/352743ef18b204bb34072b42aa8be32f05927bfa)`[EXPERIMENT] Send render request body as JSON when no bundle attached` |
17-
| Experiment branch | `experiment/3280-json-render-body` (base `upcoming-v16.3.0`) |
18-
| Demo-app harness commit (rsc-benchmar) | [`b90977ef3`](https://github.com/AbanoubGhadban/rsc-benchmar/commit/b90977ef33d72c33aacbce09b07d66db46b46155)`demo(#3280): JSON render-body experiment harness + parallel A/B tooling` |
19-
| Demo-app branch | https://github.com/AbanoubGhadban/rsc-benchmar/tree/experiment/3280-json-render-body |
20-
| Related/orthogonal PR | [#3217](https://github.com/shakacode/react_on_rails/pull/3217)`perf(pro): enable TCP_NODELAY on httpx` |
12+
| Artifact | Location |
13+
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
14+
| Issue | https://github.com/shakacode/react_on_rails/issues/3280 |
15+
| Experiment PR (the "demo") — **closed** | [#3293](https://github.com/shakacode/react_on_rails/pull/3293) (closed; experiment fully captured in this doc — see note below) |
16+
| Experiment commit (react_on_rails) | [`352743ef1`](https://github.com/shakacode/react_on_rails/commit/352743ef18b204bb34072b42aa8be32f05927bfa)`[EXPERIMENT] Send render request body as JSON when no bundle attached` |
17+
| Experiment branch | `experiment/3280-json-render-body` (base `upcoming-v16.3.0`) |
18+
| Demo-app harness commit (rsc-benchmar) | [`b90977ef3`](https://github.com/AbanoubGhadban/rsc-benchmar/commit/b90977ef33d72c33aacbce09b07d66db46b46155)`demo(#3280): JSON render-body experiment harness + parallel A/B tooling` |
19+
| Demo-app branch | https://github.com/AbanoubGhadban/rsc-benchmar/tree/experiment/3280-json-render-body |
20+
| Related/orthogonal PR | [#3217](https://github.com/shakacode/react_on_rails/pull/3217)`perf(pro): enable TCP_NODELAY on httpx` |
2121

2222
> The experiment itself was run on `upcoming-v16.3.0` (to match the renderer/gem
2323
> version the benchmark app pins). This planning doc targets `main`; the
@@ -367,11 +367,11 @@ per the issue). Its codebase-change PR has been **closed** — everything it
367367
contained (the diff, the numbers, the problems, the production plan) is
368368
preserved in this document. Production work will be a fresh PR per §5.
369369

370-
| PR | Branch | Status | Disposition |
371-
|---|---|---|---|
372-
| [#3293](https://github.com/shakacode/react_on_rails/pull/3293) | `experiment/3280-json-render-body` | **closed** | Experiment code (9-line `render_code` flip + instrumentation). Superseded by this plan; not for merge. Diff preserved verbatim in §1. |
373-
| [#3298](https://github.com/shakacode/react_on_rails/pull/3298) | `docs/3280-json-render-body-plan` (vs `upcoming-v16.3.0`) | closed | Earlier draft of this doc; relocated and re-targeted to `main`. |
374-
| this PR | `docs/3280-json-render-body-plan` (vs `main`) | open | This document. The only #3280 PR that stays open. |
370+
| PR | Branch | Status | Disposition |
371+
| -------------------------------------------------------------- | --------------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------- |
372+
| [#3293](https://github.com/shakacode/react_on_rails/pull/3293) | `experiment/3280-json-render-body` | **closed** | Experiment code (9-line `render_code` flip + instrumentation). Superseded by this plan; not for merge. Diff preserved verbatim in §1. |
373+
| [#3298](https://github.com/shakacode/react_on_rails/pull/3298) | `docs/3280-json-render-body-plan` (vs `upcoming-v16.3.0`) | closed | Earlier draft of this doc; relocated and re-targeted to `main`. |
374+
| this PR | `docs/3280-json-render-body-plan` (vs `main`) | open | This document. The only #3280 PR that stays open. |
375375

376376
[#3217](https://github.com/shakacode/react_on_rails/pull/3217) (TCP_NODELAY)
377377
is a separate issue's PR, orthogonal to #3280 (§2.6) — **left untouched**.

0 commit comments

Comments
 (0)