Skip to content

chore: improve README#1131

Merged
GabrielePicco merged 1 commit intomasterfrom
chore/improve-readme
Apr 3, 2026
Merged

chore: improve README#1131
GabrielePicco merged 1 commit intomasterfrom
chore/improve-readme

Conversation

@GabrielePicco
Copy link
Copy Markdown
Collaborator

@GabrielePicco GabrielePicco commented Apr 3, 2026

Summary

Compatibility

  • No breaking changes
  • Config change (describe):
  • Migration needed (describe):

Testing

  • tests (or explain)

Checklist

  • docs updated (if needed)
  • closes #

Summary by CodeRabbit

  • Documentation
    • Reorganized README with a new Packages section displaying available packages with version badges and documentation links.
    • Improved document structure for better visibility and navigation.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 3, 2026

Manual Deploy Available

You can trigger a manual deploy of this PR branch to testnet:

Deploy to Testnet 🚀

Alternative: Comment /deploy on this PR to trigger deployment directly.

⚠️ Note: Manual deploy requires authorization. Only authorized users can trigger deployments.

Comment updated automatically when the PR is synchronized.

@GabrielePicco GabrielePicco merged commit a915ef1 into master Apr 3, 2026
6 checks passed
@GabrielePicco GabrielePicco deleted the chore/improve-readme branch April 3, 2026 09:58
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 3, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: a61eb425-1554-4a32-92cf-48478039caed

📥 Commits

Reviewing files that changed from the base of the PR and between 02d8a41 and 799511c.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README.md file was modified to restructure the placement of the construction status warning and add package information. The "🚧 Status: Under Construction" warning block, originally positioned near the top of the document, was relocated to appear after the license section. A new "Packages" section was introduced that documents four packages with associated version badges and documentation links. The warning block is now surrounded by separator lines (---). The changes result in a net addition of 18 lines and removal of 8 lines.

Suggested reviewers

  • lucacillario
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/improve-readme

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

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

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.

1 participant