docs: docs improvements for v1.2.7 (#431)

* feat: add OpenAPI specification copying to deployment workflow

* chore: update terminology and enhance feature descriptions for clarity

* feat: add local search functionality in Docusaurus docs

* chore: update documentation and configuration for Cardano Rosetta Java, including new hardware profiles, environment variables, and user guides

* chore: update hardware profile specifications for Cardano Rosetta Java documentation

---------

Co-authored-by: matiwinnetou <mateusz.szczap@gmail.com>

Author: linconvidal

.github/workflows/deploy-docs.yml

@@ -27,6 +27,11 @@ jobs:
         working-directory: docs
     steps:
       - uses: actions/checkout@v4
+
+      - name: Copy OpenAPI spec
+        run: mkdir -p docs/static && cp api/src/main/resources/rosetta-specifications-1.4.15/api.yaml docs/static/api.yaml
+        working-directory: ${{ github.workspace }} # Run from root
+
       - uses: actions/setup-node@v4
         with:
           node-version: 18

README.md

@@ -6,25 +6,28 @@
 
 ## What the project is about?
 
-
 This repository provides a lightweight java implementation of the [Rosetta API](https://github.com/coinbase/mesh-specifications). It uses [Yaci-Store](https://github.com/bloxbean/yaci-store) as an indexer
-to fetch the data from a Cardano node. 
+to fetch the data from a Cardano node.
 
 This component consists of:
+
 - a full Cardano node
 - a Cardano Submit API
 - an indexer which stores data in Postgres
 - the Mesh (formerly Rosetta) API
 
 This implementation follows the [Rosetta API](https://docs.cdp.coinbase.com/mesh/docs/api-reference/) specification and is compatible with the [Rosetta CLI](https://docs.cdp.coinbase.com/mesh/docs/mesh-cli/).
-It contains some extensions to fit the needs of the Cardano blockchain. These changes are documented in the [wiki](https://github.com/cardano-foundation/cardano-rosetta-java/wiki/2.-Cardano-Specific-API-Additions).
+It contains some extensions to fit the needs of the Cardano blockchain. These changes are documented in the [documentation](https://cardano-foundation.github.io/cardano-rosetta-java/docs/core-concepts/cardano-addons).
 
 ## Documentation
-Detailed explanation to all components can be found in the [wiki pages](https://github.com/cardano-foundation/cardano-rosetta-java/wiki) of this repository.
+
+Detailed explanation to all components can be found in the [documentation](https://cardano-foundation.github.io/cardano-rosetta-java/docs/intro) of this repository.
 It includes explanations about the Architecture, how to build and run the components and explanations to environment variables.
 
 ## System requirements
+
 Since [Yaci-Store](https://github.com/bloxbean/yaci-store) is a comparatively lightweight indexer, the system requirements are lower than for other chain indexers. The following are the recommended system requirements for running this component:
+
 - 4CPU Cores
 - 32GB RAM
 - 1TB of storage (PRUNING_ENABLED=false) [default]
@@ -33,88 +36,109 @@ Since [Yaci-Store](https://github.com/bloxbean/yaci-store) is a comparatively li
 Better hardware will improve the performance of the indexer and the node, which will result in faster syncing times.
 
 ## Installation
-By default this Cardano-node will sync the entire chain from Genesis. 
+
+By default this Cardano-node will sync the entire chain from Genesis.
 This will take up to 48-72 hours (dependening on the system resources).
 
 ### Docker (build from source)
+
 If your user is not in the `docker` group you might have to execute these commands with `sudo`.
-The default config is focused on mainnet. If you want to test this on other Cardano netwoks (like `preview` or `preprod`) please adjust the `docker/.env.dockerfile` or read the Wiki page on [Environment variables](https://github.com/cardano-foundation/cardano-rosetta-java/wiki/5.-Environment-Variables) on other options and their default values.
+The default config is focused on mainnet. If you want to test this on other Cardano netwoks (like `preview` or `preprod`) please adjust the `docker/.env.dockerfile` or read the documentation page on [Environment variables](https://cardano-foundation.github.io/cardano-rosetta-java/docs/install-and-deploy/env-vars) on other options and their default values.
 
 ```bash
     git clone https://github.com/cardano-foundation/cardano-rosetta-java
     cd cardano-rosetta-java
     docker build -t rosetta-java -f ./docker/Dockerfile .
     docker run --name rosetta -v {CUSTOM_MOUNT_PATH}:/node --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-mid-level -p 8082:8082 --shm-size=4g -d rosetta-java
 ```
-Detailed explanation can be found in the [Wiki](https://github.com/cardano-foundation/cardano-rosetta-java/wiki/3.-Getting-Started-with-Docker).
+
+Detailed explanation can be found in the [documentation](https://cardano-foundation.github.io/cardano-rosetta-java/docs/install-and-deploy/docker).
 
 Depending on using a snapshot feature or not, this will take X amount of time. You can follow along with the commands below. Your instance is ready when you see: `DONE`.
 
 ### Offline mode
+
 If you want to run rosetta-java in offline mode you need to set the `API_SPRING_PROFILES_ACTIVE` environment variable to `offline` in `./docker/.env.dockerfile`.
 This will disable the syncing of the node and won't start the db and the indexer.
 Default is `online`.
 
 **Useful commands:**
+
 - Following Docker container logs:
+
 ```bash
     docker logs rosetta -f
 ```
+
 - Access node logs:
+
 ```bash
     docker exec rosetta tail -f /logs/node.log
 ```
+
 - Access indexer logs:
+
 ```bash
     docker exec rosetta tail -f /logs/indexer.log
 ```
+
 - Interactive access to container:
+
 ```bash
-    docker exec -it rosetta bash # direct bash access within the container 
+    docker exec -it rosetta bash # direct bash access within the container
 
 
-    # Useful commands within the container 
+    # Useful commands within the container
     cardano-cli query tip --mainnet # check node sync status
     tail -f /logs/node.log # follow node logs
     tail -f /logs/indexer.log # follow indexer logs
 ```
 
 ### Docker (using pre-built image)
+
 For every Release we provide pre-built docker images stored in the DockerHub Repositories of the Cardano Foundation ([DockerHub](https://hub.docker.com/orgs/cardanofoundation/repositories))
 To start it use the following command:
+
 ```bash
     docker run --name rosetta -v {CUSTOM_MOUNT_PATH}:/node --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-mid-level -p 8082:8082 --shm-size=4g -d cardanofoundation/cardano-rosetta-java:1.2.7
 ```
-Changes to the configuration can be made by adjusting the `docker/.env.dockerfile` file. For more information on the environment variables, please refer to the [Wiki](https://github.com/cardano-foundation/cardano-rosetta-java/wiki/5.-Environment-Variables).
+
+Changes to the configuration can be made by adjusting the `docker/.env.dockerfile` file. For more information on the environment variables, please refer to the [documentation](https://cardano-foundation.github.io/cardano-rosetta-java/docs/install-and-deploy/env-vars).
 
 If you want to use the `cardano-submit-api` you can additionally expose port `8090`. It can then be used to submit raw cbor transaction (API documentation here: [Link](https://input-output-hk.github.io/cardano-rest/submit-api/))
+
 ```bash
     docker run --name rosetta -v {CUSTOM_MOUNT_PATH}:/node --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-mid-level -p 8090:8090 -p 8082:8082 --shm-size=4g -d cardanofoundation/cardano-rosetta-java:1.2.7
 ```
+
 ### Docker compose
+
 If needed we also provide all components needed to run Rosetta in a docker-compose file.
 This will start:
+
 - Cardano-node
 - Cardano-Submit-API
 - Yaci-Store
 - Rosetta-API
 - Postgres
 
 ### Entry level hardware profile
+
 ```bash
-   docker-compose --env-file .env.docker-compose --env-file .env.docker-compose-profile-mid-level -f docker-compose.yaml up -d 
+   docker-compose --env-file .env.docker-compose --env-file .env.docker-compose-profile-mid-level -f docker-compose.yaml up -d
 ```
 
 ### A complete list of hardware profiles:
+
 ```
 .env.docker-compose-profile-entry-level
 .env.docker-compose-profile-mid-level
 ```
 
-See https://github.com/cardano-foundation/cardano-rosetta-java/wiki/9.-Hardware-Profiles a full list of hardware profiles and their configurations.
+See the [hardware profiles documentation](https://cardano-foundation.github.io/cardano-rosetta-java/docs/install-and-deploy/hardware-profiles) for a full list of hardware profiles and their configurations.
 
-Further adjustments can be made by changing `.env.docker-compose` file. For more information on the environment variables, please refer to the [Wiki](https://github.com/cardano-foundation/cardano-rosetta-java/wiki/5.-Environment-Variables).
+Further adjustments can be made by changing `.env.docker-compose` file. For more information on the environment variables, please refer to the [documentation](https://cardano-foundation.github.io/cardano-rosetta-java/docs/install-and-deploy/env-vars).
 
 ---
-Thanks for visiting us and enjoy :heart:!
 
+Thanks for visiting us and enjoy :heart:!

docs/.gitignore

@@ -3,6 +3,7 @@
 
 # Production
 /build
+/docs/static/api.yaml
 
 # Generated files
 .docusaurus

docs/docs/advanced/_category_.json renamed to docs/docs/advanced-configuration/_category_.json

@@ -1,5 +1,5 @@
 {
-  "label": "Advanced Configuration and Performance",
+  "label": "Advanced Configuration",
   "position": 5,
   "link": {
     "type": "generated-index",

docs/docs/development/performance/db-tuning.md renamed to docs/docs/advanced-configuration/db-tuning.md

@@ -141,5 +141,3 @@ If you want a UI-based approach, tools like **pgAdmin**, **pganalyze**, or **pgw
 For **real-time monitoring**, use **`pg_stat_statements`**.  
 For **logging slow queries**, enable **`auto_explain`**.  
 For **detailed analysis**, filter logs for **`Seq Scan`**.
-
-Would you like help setting up any of these? 🚀

docs/docs/getting-started/h2.md renamed to docs/docs/advanced-configuration/h2-database.md

@@ -0,0 +1,42 @@
+---
+sidebar_position: 1
+title: Pruning UTXOs
+description: Optimizing disk usage with pruning
+---
+
+# Pruning UTXOs
+
+This guide explains how to optimize disk usage in **cardano-rosetta-java** through pruning.
+
+## What is Pruning?
+
+Pruning removes spent (consumed) UTXOs from local storage, keeping only unspent UTXOs. This can reduce on-disk storage from ~1TB down to ~400GB, but discards historical transaction data.
+
+- Only unspent outputs are preserved.
+- You can still validate the chain's current state (and spend tokens), since active UTXOs remain.
+- **Enable Pruning**: Set `PRUNING_ENABLED=true` in your environment (e.g., in `.env.dockerfile` or `.env.docker-compose`).
+- **Disable Pruning** (default): Set `PRUNING_ENABLED=false`.
+
+## When to Enable Pruning
+
+- **Low Disk Environments**: If you need to minimize disk usage and only require UTXO data for current balances.
+- **Exploratory / Dev Environments**: If historical queries are not critical.
+
+## When to Avoid Pruning
+
+- **Full Historical Data Requirements**: If you need the complete transaction history—whether for exchange operations, audit trails, or compliance mandates—do not enable pruning. Pruning discards spent UTXOs, which removes older transaction data and prevents certain types of historical lookups or reporting.
+
+## Example Configuration
+
+Below is a snippet of how you might configure `.env.dockerfile` or `.env.docker-compose` for pruning:
+
+```bash
+# --- Pruning Toggle ---
+PRUNING_ENABLED=true
+# Enables pruning to reduce disk space requirements
+```
+
+## Further Reading
+
+- [Rosetta API Reference](https://docs.cdp.coinbase.com/mesh/docs/api-reference/)
+- [Yaci-Store Repository](https://github.com/bloxbean/yaci-store)