Enhance README with documentation and repository details #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
Missing website link |
jaoleal
reviewed
Jan 7, 2026
profile/README.md
Outdated
| @@ -0,0 +1,23 @@ | |||
| ## Hi there 👋 | |||
|
|
|||
| Foresta is a collection of tools for developing Bitcoin clients that offers better privacy and sovernty. | |||
There was a problem hiding this comment.
Floresta stands for the Bitcoin Open Source Software project offering florestad, a utreexo based bitcoin client, and its modules being offered trough libfloresta.
WYT ?
Member
Author
There was a problem hiding this comment.
Our branding is going more towards flexibility and reusability, so I think the original makes more sense
jaoleal
reviewed
Jan 7, 2026
jaoleal
reviewed
Jan 7, 2026
Updated README to include detailed documentation links and improved descriptions of repositories.
Davidson-Souza
force-pushed
the
Davidson-Souza-patch-1
branch
from
906552b to
ca34e5d
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive README file to the organization's profile directory, introducing Floresta - a collection of tools for developing Bitcoin clients. The README includes community links, documentation references, and a detailed repository table listing all related projects with their maintainers.
Changes:
- Added new profile README with project introduction and documentation links
- Created repository inventory table with descriptions and maintainer information
- Included community Discord server link
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,23 @@ | |||
| ## Hi there 👋 | |||
|
|
|||
| Foresta is a collection of tools for developing Bitcoin clients that offers better privacy and sovernty. You can find all our links on our [website](https://getfloresta.org). | |||
There was a problem hiding this comment.
Spelling error: "sovernty" should be "sovereignty".
Suggested change
| Foresta is a collection of tools for developing Bitcoin clients that offers better privacy and sovernty. You can find all our links on our [website](https://getfloresta.org). | |
| Foresta is a collection of tools for developing Bitcoin clients that offers better privacy and sovereignty. You can find all our links on our [website](https://getfloresta.org). |
| |------------|-------------|-----------------|----------------------| | ||
| |[`floresta`](https://github.com/getfloresta/floresta) | Floresta's monorepo. Where you can find all the libraries that makes up Floresta, as well as the binaries | [Davidson Souza](https://github.com/Davidson-Souza) | | | ||
| |[`floresta-ffi`](https://github.com/getfloresta/floresta-ffi) | Foreign Function Call assets for Floresta, built with UniFFI | [Davidson Souza](https://github.com/Davidson-Souza) | | | ||
| |[`floresta-flake`](https://github.com/getfloresta/floresta-flake) | Nix support for services, ackages and resources for Floresta | [jaoleal](https://github.com/jaoleal) | | |
There was a problem hiding this comment.
Spelling error: "ackages" should be "packages".
Suggested change
| |[`floresta-flake`](https://github.com/getfloresta/floresta-flake) | Nix support for services, ackages and resources for Floresta | [jaoleal](https://github.com/jaoleal) | | | |
| |[`floresta-flake`](https://github.com/getfloresta/floresta-flake) | Nix support for services, packages and resources for Floresta | [jaoleal](https://github.com/jaoleal) | | |
JoseSK999
reviewed
Jan 22, 2026
|
|
||
| Foresta is a collection of tools for developing Bitcoin clients that offers better privacy and sovernty. You can find all our links on our [website](https://getfloresta.org). | ||
|
|
||
| Detailed documentation for `libfloresta` is available [here](https://docs.getfloresta.sh/floresta/). Additionally, the [`floresta-docs`](https://getfloresta.github.io/floresta-docs/) mdBook provides an in-depth look at the libraries' architecture and internals. Further information can be found in the doc folder. |
Member
There was a problem hiding this comment.
I think you should link the floresta/doc folder at the end
| @@ -0,0 +1,23 @@ | |||
| ## Hi there 👋 | |||
|
|
|||
| Foresta is a collection of tools for developing Bitcoin clients that offers better privacy and sovernty. You can find all our links on our [website](https://getfloresta.org). | |||
Member
There was a problem hiding this comment.
Suggested change
| Foresta is a collection of tools for developing Bitcoin clients that offers better privacy and sovernty. You can find all our links on our [website](https://getfloresta.org). | |
| Foresta is a collection of tools for developing Bitcoin clients that offers better privacy and sovernty. You can find all our links on the [website](https://getfloresta.org). |
|
|
||
| ### About this Org | ||
|
|
||
| This organization holds all the crates related to Floresta, including our |
Member
There was a problem hiding this comment.
Suggested change
| This organization holds all the crates related to Floresta, including our | |
| This organization holds all the crates related to the Floresta project, including our |
| ### About this Org | ||
|
|
||
| This organization holds all the crates related to Floresta, including our | ||
| libraries, binaries and integration tools. Here's a list of repositories, with some description about it. |
Member
There was a problem hiding this comment.
I prefer something like
Suggested change
| libraries, binaries and integration tools. Here's a list of repositories, with some description about it. | |
| libraries, binaries and integration tools. Below is some information about each crate. |
Member
There was a problem hiding this comment.
Or about each repository. If we want to add non-crate repos to the list then we have some of them missing (e.g., book)
|
|
||
| | Repository | Description | Lead Maintainer | Secondary Maintainer | | ||
| |------------|-------------|-----------------|----------------------| | ||
| |[`floresta`](https://github.com/getfloresta/floresta) | Floresta's monorepo. Where you can find all the libraries that makes up Floresta, as well as the binaries | [Davidson Souza](https://github.com/Davidson-Souza) | | |
Member
There was a problem hiding this comment.
Suggested change
| |[`floresta`](https://github.com/getfloresta/floresta) | Floresta's monorepo. Where you can find all the libraries that makes up Floresta, as well as the binaries | [Davidson Souza](https://github.com/Davidson-Souza) | | | |
| |[`floresta`](https://github.com/getfloresta/floresta) | Floresta's monorepo, where you can find all the libraries that make up Floresta, as well as the binaries. | [Davidson Souza](https://github.com/Davidson-Souza) | | |
| |[`floresta-ffi`](https://github.com/getfloresta/floresta-ffi) | Foreign Function Call assets for Floresta, built with UniFFI | [Davidson Souza](https://github.com/Davidson-Souza) | | | ||
| |[`floresta-flake`](https://github.com/getfloresta/floresta-flake) | Nix support for services, ackages and resources for Floresta | [jaoleal](https://github.com/jaoleal) | | | ||
| |[`floresta-makepkg`](https://github.com/getfloresta/floresta-makepkg) | A `makepkg` script for building Floresta on `pacman-based` distros | [Davidson Souza](https://github.com/Davidson-Souza) | | | ||
| |[`floresta-qa-assets`](https://github.com/getfloresta/floresta-qa-assets) | Development and QA assets used for Floresta's development | [Davidson Souza](https://github.com/Davidson-Souza) | | |
Member
There was a problem hiding this comment.
What is QA asset, maybe better to write the full wording
| |[`floresta-flake`](https://github.com/getfloresta/floresta-flake) | Nix support for services, ackages and resources for Floresta | [jaoleal](https://github.com/jaoleal) | | | ||
| |[`floresta-makepkg`](https://github.com/getfloresta/floresta-makepkg) | A `makepkg` script for building Floresta on `pacman-based` distros | [Davidson Souza](https://github.com/Davidson-Souza) | | | ||
| |[`floresta-qa-assets`](https://github.com/getfloresta/floresta-qa-assets) | Development and QA assets used for Floresta's development | [Davidson Souza](https://github.com/Davidson-Souza) | | | ||
| |[`rpc-utreexo-bridge`](https://github.com/getfloresta/rpc-utreexo-bridge) | A simple and fast Utreexo bridge node. | [Davidson Souza](https://github.com/Davidson-Souza) | | |
Member
There was a problem hiding this comment.
I would remove the dot since it's a small phrase
Suggested change
| |[`rpc-utreexo-bridge`](https://github.com/getfloresta/rpc-utreexo-bridge) | A simple and fast Utreexo bridge node. | [Davidson Souza](https://github.com/Davidson-Souza) | | | |
| |[`rpc-utreexo-bridge`](https://github.com/getfloresta/rpc-utreexo-bridge) | A simple and fast Utreexo bridge node | [Davidson Souza](https://github.com/Davidson-Souza) | | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated README to include detailed documentation links and improved descriptions of repositories.