docs: misc docusaurus improvements #478
Open
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
…ents - Updated API title to reflect rebranding to Mesh API. - Enhanced some endpoint descriptions for clarity and accuracy (network status, options, block transaction). - Added detailed descriptions for Cardano-specific transaction and block metadata. - Commented out unimplemented mempool endpoints and related documentation. - Improved Docusaurus configuration for better user experience, including last update timestamps . - Updated CSS for improved layout and styling consistency across documentation pages.
- Updated example values for block, account and transaction identifiers to align with current data. - Enhanced operation types and statuses to include Cardano-specific options. - Added valid response examples to improve clarity. - Commented out unimplemented features and provided TODO notes for future implementation.
…tion layout - Updated custom CSS to enhance layout consistency, including centering the navbar and main wrapper. - Removed the proxy URL from the configuration. - Adjusted styles for the theme edit button and sidebar to improve user experience. - Deleted the outdated API specification file to streamline documentation.
Remove multiple 'examples' entries from schema definitions ('Operation', 'NetworkIdentifier'). These were intended solely for enhanced rendering in Scalar docs but caused spec-validation failures during CI builds.
Single 'example' per schema retained to ensure OpenAPI compliance and fix build errors.
…ues in API specification - Upgraded the OpenAPI generator Maven plugin from version 6.4.0 to 7.13.0. - Simplified example values in the API specification by removing unnecessary array structures for 'network' and 'status' fields.
- Renamed "Pruning UTXOs" to "Spent UTXO Pruning" for clarity. - Enhanced explanations regarding the impact and configuration of spent UTXO pruning. - Updated resource requirements in README and intro documentation to specify spent UTXO pruning.
…lti-assets section - Added a note on stake addresses to clarify the response from the `/account/balance` endpoint when queried with a stake address (available rewards). - Renamed the "Multi-Assets" section to "Native Tokens" for better alignment with terminology used in Cardano documentation.
…riables - Enhanced the performance measurements section with load test results for versions 1.2.6, 1.2.7, and 1.2.9. - Updated environment variables documentation to reflect changes in version 1.2.9, including the introduction of `REMOVE_SPENT_UTXOS` and `REMOVE_SPENT_UTXOS_LAST_BLOCKS_GRACE_COUNT`, while deprecating older variables.
- Revised storage requirements in README and intro documentation to reflect updated values for both pruning enabled and disabled scenarios. - Added clarifications regarding the limitations of searching transactions by address when pruning is enabled in the pruning and cardano-addons documentation.
|
|
@Kartiiyer12 @tienna @matiwinnetou PR ready for review. Here is a rendered version: https://linconvidal.github.io/cardano-rosetta-java/ |
| @@ -29,8 +29,8 @@ Since [Yaci-Store](https://github.com/bloxbean/yaci-store) is a comparatively li | |||
|
|
|||
| - 4CPU Cores | |||
| - 32GB RAM | |||
| - ca. > 1TB of storage (REMOVE_SPENT_UTXOS=false) [default] | |||
| - ca > 400GB of storage (REMOVE_SPENT_UTXOS=true) | |||
| - ~1.3 TB total storage (node ~250 GB + Rosetta DB ~1 TB) — pruning disabled [default] | |||
There was a problem hiding this comment.
Why do we cann this pruning again? :)
matiwinnetou
approved these changes
Jun 12, 2025
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.
This PR includes miscellaneous documentation and Docusaurus improvements, initially part of PR #456. I’ve separated these changes to facilitate delivery, as the API spec (api.yaml) fixes require further debugging and review.
Key updates:
/account/balanceendpoint behavior when queried with stake addresses (Document /account/balance Endpoint Behavior for Stake Addresses #473).oldest_block_identifierbehavior in /network/status when pruning is enabled (Document oldest_block_identifier Behavior When Pruning is Enabled #474).