Skip to content

Conversation

@ffranr
Copy link
Contributor

@ffranr ffranr commented Nov 26, 2025

This PR improves the structure and maintainability of the README by:

  • Removing the daemon versions table, which is now redundant with the
    GitHub release notes. This reduces duplication and potential inconsistencies.
  • Archiving the LiT/LND compatibility matrix in docs/compatibility.md
    to preserve historical data without requiring future updates in the README.
  • Updating guidance to refer users to release notes for required min LND version and included daemon versions.
  • Aligning table columns and reformatting lines to respect a soft max line length of 80 columns, improving readability and consistency.

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.
@ffranr ffranr self-assigned this Nov 26, 2025
@gemini-code-assist
Copy link

Summary of Changes

Hello @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

  • Documentation Cleanup: Removed the redundant daemon versions table from the README, as this information is now maintained in GitHub release notes.
  • Compatibility Matrix Archival: Archived the LiT/LND compatibility matrix into a new dedicated file, docs/compatibility.md, to preserve historical data without cluttering the main README.
  • Updated Version Guidance: Revised the README to direct users to GitHub release notes for the most current information regarding minimum LND versions and included daemon versions.
  • Readability Improvements: Reformatted various sections of the README to align table columns and adhere to a soft maximum line length of 80 columns, enhancing overall readability and consistency.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@ffranr ffranr force-pushed the wip/readme-cleanup branch from 8602fa9 to 6cb37e3 Compare November 26, 2025 16:44
Copy link

@gemini-code-assist gemini-code-assist bot left a 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.

@ffranr ffranr added the no-changelog This PR is does not require a release notes entry label Nov 26, 2025
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog This PR is does not require a release notes entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants