Skip to content

Update README.md#47

Merged
malberts merged 1 commit intomasterfrom
kghbln-readme
Jul 10, 2025
Merged

Update README.md#47
malberts merged 1 commit intomasterfrom
kghbln-readme

Conversation

@kghbln
Copy link
Member

@kghbln kghbln commented Jul 10, 2025

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions to require the latest major version of the Modern Timeline extension.
    • Corrected link text in the contribution and support section for improved clarity.

@coderabbitai
Copy link

coderabbitai bot commented Jul 10, 2025

📝 Walkthrough

Walkthrough

The README.md file was updated to specify a new major version requirement for the Modern Timeline extension in installation instructions, changing the Composer package version from "~1.0" to "~2.0". A minor correction was also made in the contribution section, updating the link text from "Professional.Wiki" to "Professional Wiki".

Changes

File Change Summary
README.md Updated Composer package version constraint from "~1.0" to "~2.0"; corrected link text in contribution section.

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
README.md (2)

42-45: Use spaces instead of hard tabs & switch to caret version constraint

The JSON snippet keeps hard-tab indentation on lines 42-44 (MD010) and pins the package with ~2.0, which only allows 2.0.*.
Consider switching to spaces and a caret to get all minor/patch releases of v2.

-	"require": {
-		"professional-wiki/modern-timeline": "~2.0"
+  "require": {
+    "professional-wiki/modern-timeline": "^2.0"

48-53: Fence the single-line snippet to satisfy MD046

The indented line renders as a code block but violates markdownlint’s “fenced” style rule. Wrap it in back-ticks (and, optionally, adopt the caret constraint for consistency).

-    "professional-wiki/modern-timeline": "~2.0"
+```json
+"professional-wiki/modern-timeline": "^2.0"
+```
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 435524a and a85f131.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

43-43: Hard tabs
Column: 1

(MD010, no-hard-tabs)


44-44: Hard tabs
Column: 1

(MD010, no-hard-tabs)


51-51: Code block style
Expected: fenced; Actual: indented

(MD046, code-block-style)

Comment on lines 163 to 166

[Professional MediaWiki support](https://professional.wiki/en/support) is available via
[Professional.Wiki](https://professional.wiki/).
[Professional Wiki](https://professional.wiki/).

Copy link

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Ensure all occurrences of the old “Professional.Wiki” label are updated

This fix touches one instance, but there may be more. Quick verification:


🏁 Script executed:

rg --ignore-case "Professional\.Wiki" README.md docs

Length of output: 784


🏁 Script executed:

#!/bin/bash
# Search specifically for link labels using the old "Professional.Wiki" text
rg -n "\\[Professional\\.Wiki\\]" --ignore-case --glob "*.md"

Length of output: 134


Update remaining “Professional.Wiki” link label

Search uncovered one more occurrence in README.md that needs updating:

  • README.md:151
    - Contact [Professional.Wiki](https://professional.wiki/) for
    + Contact [Professional Wiki](https://professional.wiki/) for

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents
In README.md around lines 151, update the link label from “Professional.Wiki” to
“Professional Wiki” to maintain consistent branding. Locate the link text and
modify it accordingly without changing the URL.

@malberts malberts merged commit 3529e04 into master Jul 10, 2025
7 of 17 checks passed
@malberts malberts deleted the kghbln-readme branch July 10, 2025 13:55
@coderabbitai coderabbitai bot mentioned this pull request Sep 24, 2025
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