Improve documentation clarity and navigation #171
Conversation
Updated the README to enhance the table of contents and add a Quick Start section with installation instructions for different operating systems. Signed-off-by: Francesco Miliani <[email protected]>
This struct provides (de)serialization of byte arrays as hex strings for human-readable formats and as raw bytes for binary formats. It includes limitations and motivation for its design. Signed-off-by: Francesco Miliani <[email protected]>
Signed-off-by: Francesco Miliani <[email protected]>
Signed-off-by: Francesco Miliani <[email protected]>
Signed-off-by: Francesco Miliani <[email protected]>
Signed-off-by: Francesco Miliani <[email protected]>
Signed-off-by: Francesco Miliani <[email protected]>
|
Thank you for your PR and your interest in contributing! We kindly ask you to review our contributing guidelines before submitting PRs. These guidelines require prior communication via Discord/GitHub Issues and include essential instructions, such as the requirement for GPG signing your commits. Regarding the readme changes: We are unable to accept the proposed platform-specific build instructions. They do not integrate well into the existing readme structure, and crucially, we cannot commit to maintaining their accuracy across various platforms as the library evolves. We can mention that GMP is required but prefer to refer to external resources for detailed installation instructions. For the error message: Could you please provide the exact command you used that produced the error? Our current CI checks (including build, test, and docs) have not detected this issue, and knowing the command will help us reproduce and diagnose it. Thank you for your efforts and cooperation! |
2 participants
Revise the table of contents and enhance the Quick Start section in the README. Fix documentation paths across multiple files to ensure correct linking.
