juno

juno copied to clipboard

This PR improves Juno's documentation, enhancing the structure, navigation, and user experience. Below is a list of the tasks completed:

• [x] Build a script to extract Juno’s config from the codebase generate-config.js
• [x] Integrate the script to generate the config table and embed it in the docs automatically
• [x] Add a locally indexed search bar with https://github.com/easyops-cn/docusaurus-search-local
• [x] Migrate Docusaurus from v2 to v3: https://docusaurus.io/docs/migration/v3
• [x] Organise versioning and include instructions in the README
• [x] Organise the footer (add blog, release notes, config links)
• [x] Remove the autogenerated sidebar and map it manually
• [x] Change the docs font to MD Sans (Juno’s brand secondary font)
• [x] Rewrite the Juno Configuration guide and include environment variables instructions
• [x] Rewrite the Database Snapshots guide
• [x] Rewrite the Hardware Requirements guide and increase minimum storage to 250GB
• [x] Rewrite the Running Juno on GCP guide with updated screenshots
• [x] Create a Juno intro page
• [x] Create a Frequently Asked Questions (FAQ) page
• [x] Create a Running Juno guide
• [x] Rewrite the Updating Juno guide
• [x] Create an Interacting with Juno guide (JSON-RPC and WebSocket)
• [x] Reference the Starknet API reference and request builder
• [x] Create a Monitoring Juno guide
• [x] Update snapshot to block 640855
• [ ] Create a Running a Juno P2P Node guide
• [ ] Render Starknet Node API spec with docusaurus-openrpc (Issue #1184)

I intend to deploy the changes with the Juno v0.12 release or when all improvements are completed, whichever comes first.

May 03 '24 13:05 LordGhostX

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 75.47%. Comparing base (3d16548) to head (05d8d2d).

@@            Coverage Diff             @@
##             main    #1857      +/-   ##
==========================================
+ Coverage   75.30%   75.47%   +0.16%     
==========================================
  Files          97       97              
  Lines        8333     8333              
==========================================
+ Hits         6275     6289      +14     
+ Misses       1522     1514       -8     
+ Partials      536      530       -6     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

May 03 '24 13:05 codecov[bot]