Update README.md

[tomlm]

Update readme with pointer to wiki

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a modification to the README.md file by adding a new section with the heading "See wiki for more documentation". This new section includes a hyperlink directing users to the project's wiki page located at https://github.com/jinek/Consolonia/wiki. The change aims to provide additional guidance to users by pointing them towards more comprehensive documentation resources beyond the README file. The modification is straightforward, involving the insertion of a single section with a header and a link to external documentation.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ee3e836 and 24639d5.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 Markdownlint (0.37.0)

README.md

17-17: null
Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (2)

README.md (2)

15-15: LGTM!

Good use of spacing between sections to improve readability.

---

16-17: 🛠️ Refactor suggestion

Format the URL as a proper markdown link

While the URL addition is valuable, it should follow markdown best practices by using proper link formatting.

Apply this change:

 ## See wiki for more documentation
-https://github.com/jinek/Consolonia/wiki
+[Project Wiki](https://github.com/jinek/Consolonia/wiki)

Let's verify the wiki URL is accessible:

✅ Verification successful

Format the URL as a proper markdown link

The wiki URL is accessible (HTTP 200 response), so the suggested markdown formatting improvement should be applied:

 ## See wiki for more documentation
-https://github.com/jinek/Consolonia/wiki
+[Project Wiki](https://github.com/jinek/Consolonia/wiki)

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the wiki URL is accessible
# Expected result: HTTP 200 OK response

curl -I https://github.com/jinek/Consolonia/wiki

Length of output: 4917

🧰 Tools

🪛 Markdownlint (0.37.0)

17-17: null
Bare URL used

(MD034, no-bare-urls)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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.