Skip to content

Fix: split merged code blocks in jen build section (Issue #4)#168

Open
xy769 wants to merge 2 commits intooopsio:mainfrom
xy769:fix/cli-markdown-format
Open

Fix: split merged code blocks in jen build section (Issue #4)#168
xy769 wants to merge 2 commits intooopsio:mainfrom
xy769:fix/cli-markdown-format

Conversation

@xy769
Copy link
Copy Markdown

@xy769 xy769 commented May 7, 2026

Description

Fixes Issue #4: Fix indentation or formatting in a documentation code example.

In the jen build command documentation section, three separate commands were merged into a single code block within each tab. This made the commands hard to read and copy.

Type of Change

  • Documentation (documentation only)

Changes

  • docs/content/docs/cli.mdx: Split the three jen build commands into individual code blocks for each package manager tab (npm, pnpm, yarn, bun)

Before:
```bash npx jen build npx jen build --adapter=vercel npx jen build --adapter=cloudflare ```

After:
```bash npx jen build ```
```bash npx jen build --adapter=vercel ```
```bash npx jen build --adapter=cloudflare ```

How Has This Been Tested

  • Documentation-only change (no code affected)

Checklist

  • My code follows the project style guidelines
  • I have performed a self-review of my own changes
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

xy769 added 2 commits May 7, 2026 22:02
Issue oopsio#4: Fix indentation or formatting in a documentation code example.
Split the three jen build commands into individual code blocks for clarity.
Each command should be in its own code block for readability.
@netlify
Copy link
Copy Markdown

netlify Bot commented May 7, 2026

Deploy Preview for polite-rabanadas-e7f4e1 failed.

Name Link
🔨 Latest commit 9e679a8
🔍 Latest deploy log https://app.netlify.com/projects/polite-rabanadas-e7f4e1/deploys/69fc9ba7575b820008816a11

@vercel
Copy link
Copy Markdown

vercel Bot commented May 7, 2026

@xy769 is attempting to deploy a commit to the kessud2021's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

The jen build command documentation in the CLI reference is corrected to present clear, separate code examples for the base command and each adapter variant across all package manager tabs (npm, pnpm, yarn, bun), replacing previously garbled or duplicated invocations.

Changes

CLI Documentation Clarification

Layer / File(s) Summary
Build Command Examples
docs/content/docs/cli.mdx
The jen build command examples under npm, pnpm, yarn, and bun tabs are restructured to show the base command followed by distinct adapter-specific invocations (--adapter=vercel and --adapter=cloudflare).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 With whiskers twitched and eyes so bright,
The CLI docs now parse just right,
Each adapter shines in blocks so clean—
npm, pnpm, yarn, bun seen!
No more tangled code to fight,
Our builders hop with pure delight! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: fixing split/separated code blocks in the jen build documentation section, directly addressing Issue #4.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The PR description is well-structured and follows the template with clear context, issue reference, type of change, detailed before/after examples, testing confirmation, and completed checklist items.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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 and usage tips.

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