Move configuration into its own section in readme

[alistair3149]

Summary by CodeRabbit

• Documentation
  • Improved organization and clarity in usage instructions.
  • Removed outdated configuration details and introduced updated PHP configuration guidance.
  • Expanded examples with detailed usage scenarios and proper formatting guidelines for options and templates.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes update the project's documentation in the README file. The modification involves removing the previous "Configuration" section and reorganizing the content. A new "PHP Configuration" section is added after the "Examples" section. Furthermore, the "Examples" section is expanded with additional subsections—"Options parameter" and "Using templates"—which provide detailed examples, including JSON structures and formatting guidelines.

Changes

File	Change Summary
README.md	Removed the "Configuration" section; Added a "PHP Configuration" section positioned after the "Examples" section; Expanded the "Examples" section with "Options parameter" and "Using templates" subsections that include JSON examples and formatting clarifications.

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

README.md (3)

201-207: Addition of the Options Parameter Example

The newly added "#### Options parameter" subsection and its JSON example provide valuable clarification. To further improve the documentation, please specify the language for the fenced code block to satisfy markdownlint (e.g., use ```json).

-```
+```json

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

207-207: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

---

226-231: Using Templates Code Block Lacks Language Specifier

The "#### Using templates" section offers a clear usage example. However, the fenced code block does not specify a language. Adding a language like text (or another appropriate tag) will help meet markdown lint requirements.

-```
+```text

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

226-226: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

---

232-232: Inline Code Cleanup in Description

The inline code spans in the sentence (e.g., around NetworkPages and NetworkOptions) include extraneous spaces. Removing any leading or trailing spaces inside the backticks will improve compliance with markdown style guidelines (MD038).

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 347d140 and e22dd86.

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

207-207: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

---

226-226: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

---

233-233: Spaces inside code span elements
null

(MD038, no-space-in-code)

🔇 Additional comments (2)

README.md (2)

24-24: New TOC Entry for PHP Configuration

A new "PHP Configuration" link has been correctly added to the Table of Contents. Please verify that the anchor (#php-configuration) matches the header in the later section.

---

234-234: New PHP Configuration Section

The "PHP Configuration" section is now separated out nicely after the examples, offering clear guidance on available configuration options via LocalSettings.php. Ensure that the documented default values align with those in extension.json.