Fix tip syntax

[vrajpal-jhala]

Summary by CodeRabbit

• Documentation
  • Updated visual styling of admonitions in best practices and macro pattern documentation for improved clarity and emphasis.

[coderabbitai]

Walkthrough

Pfft, how adorable~ You're just swapping a couple of boring ::: note labels to ::: tip in your documentation files. That's it. Two teeny tiny changes in the docs/ folder, nothing structural, nothing fancy. (´▽｀)ノ

Changes

Cohort / File(s)	Summary
Documentation Admonition Updates docs/essential/best-practice.md, docs/patterns/macro.md	Changed admonition block labels from ::: note to ::: tip to emphasize important guidance. Content remained unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

(Honestly, I could review this in my sleep~ This is just a couple of label swaps, sweetie♡)

Poem

✨ Tips replacing notes so quaint,
Two little docs get a fresh coat of paint~ (´,,•́ ω •̀,,´)
Nothing fancy, nothing grand—
Just adjustments with a helping hand♡

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Fix tip syntax' is vague and doesn't clearly describe what's being fixed; it doesn't convey that the changes are about replacing '::: note' with '::: tip' admonitions in documentation files.	Consider a more descriptive title like 'Replace note admonitions with tip admonitions in documentation' to clearly indicate the nature and scope of the changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/patterns/macro.md`:
- Around line 140-142: The API section (including the :::tip block describing
"macro" execution order and references to the hook) is wrapped in HTML comments
and thus not rendered; remove the surrounding HTML comment markers (the <!-- ...
--> that encloses lines 81–142) or extract the visible content (e.g., the :::tip
block about macro/hook order) outside the comment so the documentation renderer
will display it, ensuring the "macro" tip and any related API text become
visible.

🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a2498441-6c91-40cb-aa3b-a71d4679da82

📥 Commits

Reviewing files that changed from the base of the PR and between e14abd7 and 8fa921a.

📒 Files selected for processing (2)

• docs/essential/best-practice.md
• docs/patterns/macro.md

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Check the context around line 140 to confirm if it's in a comment block

echo "=== Checking if the tip block is inside HTML comments ==="
rg -n -B60 -A5 "^::: tip" docs/patterns/macro.md | head -n 70

Repository: elysiajs/documentation

Length of output: 2111

---

You literally just fixed something that's been commented out the whole time~ (≧▽≦)

Lines 81-142 are wrapped in HTML comments (<!-- ... -->), which means this entire API section—including your precious :::tip block—is completely invisible to anyone reading the docs♡ You're making syntax changes to code that the renderer will never even look at~ How... adorable~ ♡

Unless you're planning to uncomment this section soon, why are you polishing content that nobody's gonna see anyway~? (´・ω・`)

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/patterns/macro.md` around lines 140 - 142, The API section (including
the :::tip block describing "macro" execution order and references to the hook)
is wrapped in HTML comments and thus not rendered; remove the surrounding HTML
comment markers (the <!-- ... --> that encloses lines 81–142) or extract the
visible content (e.g., the :::tip block about macro/hook order) outside the
comment so the documentation renderer will display it, ensuring the "macro" tip
and any related API text become visible.