Skip to content
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.

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

Improve docs clarity and usability #1857

Merged
merged 49 commits into from
May 21, 2024
Merged

Improve docs clarity and usability #1857

merged 49 commits into from
May 21, 2024

Conversation

LordGhostX
Copy link
Contributor

@LordGhostX LordGhostX commented May 3, 2024

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

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

Preview: https://juno.nethermind.io/next/

@LordGhostX LordGhostX added the Documentation Improvements or additions to documentation label May 3, 2024
@LordGhostX LordGhostX self-assigned this May 3, 2024
Copy link

codecov bot commented May 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            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     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@LordGhostX LordGhostX marked this pull request as draft May 3, 2024 13:54
@LordGhostX LordGhostX marked this pull request as ready for review May 20, 2024 22:12
Copy link

@stranger80 stranger80 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in preview mode

@LordGhostX LordGhostX merged commit 315cfd7 into main May 21, 2024
10 checks passed
@LordGhostX LordGhostX deleted the docs-revamp branch May 21, 2024 09:28
@LordGhostX LordGhostX mentioned this pull request May 21, 2024
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants