Conversation
There was a problem hiding this comment.
Pull request overview
Updates the documentation set for the 0.15.0 release, aligning versioned docs/sidebars and operational guides with current configuration flags and supported RPC/WS API versions.
Changes:
- Reformat
docs/versions.jsonand refresh0.15.0versioned docs content. - Update supported JSON-RPC / WebSocket API version listings and examples.
- Add/reflect new tuning + config options and improve Kubernetes deployment instructions.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/versions.json | Reformats the versions list into a multi-line JSON array. |
| docs/versioned_sidebars/version-0.15.0-sidebars.json | Adjusts the OpenRPC playground sidebar link URL. |
| docs/versioned_docs/version-0.15.0/websocket.md | Updates supported WS API versions and removes older version examples. |
| docs/versioned_docs/version-0.15.0/tuning.md | Adds guidance for --db-memtable-count. |
| docs/versioned_docs/version-0.15.0/staking-validator.md | Minor wording/grammar improvement. |
| docs/versioned_docs/version-0.15.0/running-juno.md | Updates Rust version prerequisite. |
| docs/versioned_docs/version-0.15.0/json-rpc.md | Updates supported RPC API versions and removes older version examples. |
| docs/versioned_docs/version-0.15.0/_config-options.md | Adds db-memtable-count and log-json to the config options table. |
| docs/docs/running-on-kubernetes.md | Improves Helm install example (testing mode) and quotes PVC label selector. |
Comments suppressed due to low confidence (1)
docs/versioned_docs/version-0.15.0/websocket.md:300
- In the v0.10.1 WebSocket example tab, the sample command connects to
/ws/v0_9, which contradicts the tab label and the supported-versions list (/ws/v0_10). This will mislead users testing the v0.10 endpoint; update the example URL to use the v0.10 endpoint (and consider double-checking the other tabs for consistency).
<TabItem value="v10" label="v0.10.1">
```bash
# wscat
$ wscat -c ws://localhost:6061/ws/v0_9
> {"jsonrpc": "2.0", "method": "juno_version", "id": 1}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
There were some changes to the docs as well. Please make sure they match with the versioned docs (I think I put a CI a while back to check exactly this) |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3496 +/- ##
==========================================
+ Coverage 75.40% 75.42% +0.02%
==========================================
Files 385 385
Lines 34983 34983
==========================================
+ Hits 26380 26387 +7
+ Misses 6745 6742 -3
+ Partials 1858 1854 -4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@rodrodros, these changes are based on some divergence between docs and versioned docs that the action detected during the 0.15.20 release. I think when I added the k8s docs, I did not update them all equally. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Yaroslav Kukharuk <i.kukharuk@gmail.com>
No description provided.