-
Notifications
You must be signed in to change notification settings - Fork 110
Cleanup and streamline README formatting and version guidance #1179
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
This information is now available in the GitHub release notes for each release. Removing it from the README simplifies the project release procedure (no need to update) and avoids unnecessary duplication, reducing the risk of inconsistencies.
Summary of ChangesHello @ffranr, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request aims to improve the structure and maintainability of the project's documentation. It centralizes version compatibility guidance by directing users to GitHub release notes and a new archived document, thereby reducing duplication and enhancing the clarity of the main README. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
8602fa9 to
6cb37e3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request effectively cleans up the README.md by moving version compatibility information to a separate file and referring to the release notes, which improves the document's structure and maintainability. The reformatting to an 80-column width also enhances readability. My review identifies a couple of instances where a link to a removed section was left behind, resulting in a broken link. I've provided suggestions to fix these.
Move the LiT/LND compatibility matrix into docs/compatibility.md for archival so future releases no longer require README updates to adjust the table. Update README to direct users to release notes for minimum lnd versions and fall back to the archived table when not specified.
Reformatted multiple lines in the README to follow the soft maximum line length of 80 columns, improving readability.
6cb37e3 to
99cf5bd
Compare
This PR improves the structure and maintainability of the README by:
GitHub release notes. This reduces duplication and potential inconsistencies.
docs/compatibility.mdto preserve historical data without requiring future updates in the README.