Various formatting improvements

[ravage84]

For better readability.

Summary by CodeRabbit

• Documentation
  • Updated README.md with improved formatting and clarity throughout, including better code block formatting for commands, inline code formatting for configuration options and filenames, and restructured sections for enhanced readability across sysctl instructions, performance schema guidance, FAQ, CVE checks, Vagrant setup, and remote usage documentation.

[coderabbitai]

📝 Walkthrough

Walkthrough

README.md documentation is updated throughout with consistent formatting: configuration filenames, command options, and file permissions are wrapped in inline backticks; command examples are placed in fenced code blocks; and instructional text is reworded for clarity across installation guidance, FAQ, and deployment sections.

Changes

Documentation Formatting and Clarity

Layer / File(s)

Summary

README formatting consistency updates README.md

Performance schema activation (line 226), aio-max-nr instructions (line 292), remote minimal usage options (lines 317–321), AHA HTML report generation examples (lines 457–466), FAQ config guidance (lines 493, 523, 543), CVE check instructions (lines 575–580), remote host connection options (lines 589–612), and Vagrant setup steps (lines 653–668) are reformatted with standardized inline backticks for code elements, fenced code blocks for commands, and reworded text for clarity.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through typos and brackets,
Adding backticks to all code snippets!
Now docs shine clear in formatted light,
Every comma and code block sits just right. ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Various formatting improvements' is vague and generic, using non-descriptive language that doesn't convey specific information about what was changed in the README.	Consider using a more specific title like 'Improve README formatting and code block consistency' to better describe the actual changes made to documentation.

✅ Passed checks (4 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.
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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 3

🤖 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 `@README.md`:
- Around line 589-597: Update the fenced code blocks in README.md that contain
the option lists (e.g., the blocks starting with lines containing "--host
<hostname> ..." and the subsequent blocks for "--forcemem ..." and "--skipsize
...") to include a language identifier (use "text" or "bash") after the opening
triple backticks so markdown lint MD040 is resolved and syntax highlighting is
preserved; ensure each of the three option-list fences is changed from ``` to
```text (or ```bash) consistently.
- Line 661: Replace the split inline link for the git clone instruction so the
README shows a copy/paste-ready command instead of separated text and URL;
update the line containing "`git clone`
<https://github.com/jmrenouard/MySQLTuner-perl/.git>" to a single full command
(e.g., "git clone https://github.com/jmrenouard/MySQLTuner-perl.git") so users
can copy/paste directly.
- Around line 317-321: Fix the grammar and clarity in the README remote-usage
paragraph: correct the typo "shoud" to "should", change "an MySQLTuner analysis"
to "a MySQLTuner analysis" and rephrase the last sentence to read more clearly
(mention the flags `--forcemem` and `--forceswap` and that you can set them to
your server's actual RAM/swap values); retain the note about defaulting memory
and swap to 1GB since version 2.1.10 and ensure the three sentences read
fluently together.

🪄 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: 82c99252-4a6e-4349-a22a-99faff6cd76d

📥 Commits

Reviewing files that changed from the base of the PR and between 5a70ea8 and 177c798.

📒 Files selected for processing (1)

• README.md

[jmrenouard]

Add language identifiers to fenced code blocks