Skip to content

docs: enhance README for clarity and add contributing guidelines #606

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs: enhance README for clarity and add contributing guidelines #606

wants to merge 6 commits into from

Conversation

linconvidal
Copy link
Member

Fix #598.

  • Introduced a new CONTRIBUTING.md file outlining contribution guidelines, development environment setup, and testing procedures.
  • Enhanced README.md with updated project overview, key features, quick start instructions, and detailed API usage examples.
  • Improved documentation structure for better navigation and clarity, including links to relevant resources and support channels.

@linconvidal
docs: enhance README for clarity and add contributing guidelines
6ffb383 
- Introduced a new CONTRIBUTING.md file outlining contribution guidelines, development environment setup, and testing procedures.
- Enhanced README.md with updated project overview, key features, quick start instructions, and detailed API usage examples.
- Improved documentation structure for better navigation and clarity, including links to relevant resources and support channels.
@linconvidal linconvidal added this to the 1.4.0 milestone Sep 12, 2025
@linconvidal linconvidal added the documentation Improvements or additions to documentation label Sep 12, 2025
@linconvidal linconvidal moved this from Backlog to In review in Rosetta Java Kanban Sep 12, 2025
@linconvidal
docs: update resource requirements and pruning configuration in docum…
0288cee 
…entation

- Revised README.md to clarify resource requirements for different hardware profiles, including updated storage needs for pruning enabled and disabled scenarios.
- Enhanced documentation on pruning configuration, specifying default values and safety margins for spent UTXO pruning.
- Updated environment variable documentation to reflect changes in default settings for pruning options.
@linconvidal
Copy link
Member Author

@Kartiiyer12 Updated pruning defaults from 2,160 blocks (~12 hours) to 129,600 blocks (~30 days) based on the chore/increase-pruning-interval branch. Enhanced storage requirements table with separate columns for pruning enabled/disabled scenarios, showing mainnet requires 750GB with pruning vs 1.3TB without. Updated all documentation files (README.md, pruning.md, env-vars.md, intro.md) to reflect that pruning will be enabled by default with the new 30-day safety margin.

@linconvidal linconvidal marked this pull request as ready for review September 16, 2025 18:35
@linconvidal linconvidal moved this from In review to In progress in Rosetta Java Kanban Sep 18, 2025
@linconvidal
docs: update README and Docker documentation for environment management
260b865 
- Enhanced README.md to clarify log viewing instructions and added commands for merging environment files to avoid warnings.
- Updated Docker documentation to include tips for managing environment files and emphasized the deprecation of the single Docker image deployment in favor of Docker Compose for better modularity and resource management.
@linconvidal
docs: cleanup tags, highlight pruning info and other cosmetics
fb39a9e 
- Revised README.md to clarify that Spent UTXO pruning is enabled by default starting from v1.4.0.
- Enhanced warnings about the deprecation of the single Docker image deployment.
@linconvidal
docs: enhance multi-assets guide with account balance and UTXO queries
3e32e9e 
- Updated the multi-assets documentation to clarify the usage of `/account/balance` and `/account/coins` endpoints for querying account balances and UTXOs.
- Added detailed request and response examples for both endpoints, including information on querying with stake addresses and known issues.
- Improved structure with tabs for better navigation and clarity.
@linconvidal
Copy link
Member Author

@Kartiiyer12 Completed multiple documentation improvements across three commits.

First, added clear instructions for merging environment files using cat command to avoid Docker Compose warnings about duplicate variable definitions (commit 260b865). Unified preprod and mainnet examples for consistency and added troubleshooting tips.

Second, converted all warnings to GitHub-flavored alert syntax using [!WARNING], [!NOTE], and [!IMPORTANT] for better rendering (commit fb39a9e). Moved pruning information prominently to Quick Start section with version note "Starting from v1.4.0". Fixed troubleshooting table to accurately state queries "return incomplete data" instead of "fail". Removed all Discord references and deprecated Docker badge links as requested.

Third, fixed Multi-Assets documentation by splitting Account Balance Queries section to correctly show /account/balance and /account/coins as separate endpoints with tabbed interface (commit 3e32e9e). Tested actual endpoints to verify response structures match documentation. Added proper request/response examples for each endpoint and integrated note about historical rewards query bug (Issue #590).

@linconvidal linconvidal moved this from In progress to In review in Rosetta Java Kanban Sep 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Kartiiyer12 Kartiiyer12 Kartiiyer12 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
Rosetta Java Kanban
Status: In review
Milestone
1.4.0
Development

Successfully merging this pull request may close these issues.

Revamp readme to improve readability
2 participants
@linconvidal @Kartiiyer12