Skip to content

docs: fix inline escaing - #4312

Merged
pi0 merged 2 commits into
nitrojs:mainfrom
posva:patch-1
Jun 5, 2026
Merged

pi0 merged 2 commits into
nitrojs:mainfrom
posva:patch-1

Conversation

@posva

@posva posva commented Jun 4, 2026

Copy link
Copy Markdown
Collaborator

Couldn't build the docs locally so I figured I could test with a preview deploy

@posva
posva requested a review from pi0 as a code owner June 4, 2026 13:48
@vercel

vercel Bot commented Jun 4, 2026

Copy link
Copy Markdown

@posva is attempting to deploy a commit to the Nitro Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jun 4, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: de570d75-0ce3-408c-bf01-391178d9aae1

📥 Commits

Reviewing files that changed from the base of the PR and between a75e3a5 and af8ea1b.

📒 Files selected for processing (1)
  • docs/1.docs/6.server-entry.md

📝 Walkthrough

Walkthrough

This PR updates documentation formatting in the server entry guide. A single line adjusts the terminal log snippet to use double backticks for consistent Markdown inline code styling.

Changes

Documentation Formatting

Layer / File(s) Summary
Server entry backtick formatting
docs/1.docs/6.server-entry.md
The server.ts detection log message formatting uses double backticks for inline code styling instead of single backticks.

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title follows conventional commits format with 'docs:' prefix but contains a spelling error ('escaing' instead of 'escaping'), which obscures the intent. Fix the typo in the title to 'docs: fix inline escaping' for clarity and professionalism.
Description check ❓ Inconclusive The description is vague and does not clearly explain what the PR fixes or why the changes were made. Add more details about what was fixed (e.g., 'fix backtick formatting in server-entry documentation').
✅ Passed checks (3 passed)
Check name Status Explanation
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.

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

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

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.

@pkg-pr-new

pkg-pr-new Bot commented Jun 4, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/nitro@4312

commit: dd01a10

@vercel

vercel Bot commented Jun 4, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
nitro.build Ready Ready Preview, Comment Jun 4, 2026 6:46pm

Request Review


::tip
When `server.ts` is detected, Nitro will log in the terminal: `Detected \`server.ts\` as server entry.`
When `server.ts` is detected, Nitro will log in the terminal: ``Detected `server.ts` as server entry.``

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now rendering like this

Image

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perfect!

@posva
posva requested a review from pi0 June 5, 2026 14:37
@pi0
pi0 merged commit 4ab22a9 into nitrojs:main Jun 5, 2026
11 of 12 checks passed
@posva
posva deleted the patch-1 branch June 5, 2026 15:26
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