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

[Docs] Refactoring the PATH Developer Guide docs #137

Merged
merged 14 commits into from
Jan 21, 2025
Merged

Conversation

Olshansk
Copy link
Contributor

@Olshansk Olshansk commented Jan 15, 2025

Summary

Restructure config management and documentation for better organization and clarity

Primary Changes:

Secondary changes:

  • Remove usage of ./bin/config/.config.yaml and bias to ./local/path/config/.config.yaml everywhere
  • Improve error messages and config validation in Makefiles
  • Update config file copy/preparation commands for better usability
  • Move test, docs and envoy targets into separate Makefiles for better organization
Screenshot 2025-01-20 at 7 02 19 PM

Type of change

Select one or more from the following:

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Documentation
  • Other (specify)

Testing

  • All Tests: make test_all
    • make test_e2e_shannon_relay
    • make test_e2e_morse_relay
    • Manual curl:
       curl http://localhost:3070/v1/endpoint_1_static_key \
           -X POST \
           -H "authorization: api_key_1" \
           -H "target-service-id: anvil" \
           -d '{"jsonrpc": "2.0", "id": 1, "method": "eth_blockNumber" }'
  • Documentation: make docusaurus_start; only needed if you make doc changes

Sanity Checklist

  • I have tested my changes using the available tooling
  • I have commented my code
  • I have performed a self-review of my own code; both comments & source code
  • I create and reference any new tickets, if applicable
  • I have left TODOs throughout the codebase, if applicable

@Olshansk Olshansk added the documentation Improvements or additions to documentation label Jan 15, 2025
@Olshansk Olshansk self-assigned this Jan 15, 2025
@Olshansk Olshansk added this to the PATH Adoption milestone Jan 20, 2025
@Olshansk Olshansk changed the title [WIP] Refactoring PATH docs [Docs] Refactoring the PATH Developer Guide docs Jan 21, 2025
@Olshansk Olshansk marked this pull request as ready for review January 21, 2025 02:35
@Olshansk Olshansk requested review from adshmh and commoddity January 21, 2025 02:35
Copy link
Contributor Author

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

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

@adshmh @commoddity PTAL a detail look.

Need a close set of 👀 and 👐 on this one as I touched/refactored a lot of this on the developer experience front.

Copy link
Contributor

@commoddity commoddity left a comment

Choose a reason for hiding this comment

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

Great PR. Loving the way the docs are taking shape here; the splitting apart of some of the bigger pages into different sections makes a world of difference in reducing the mental overload. Ditto for the Makefiles.

Just a few comments and notes but definitely like what this is doing to the docs.

Makefile Show resolved Hide resolved
Makefile Show resolved Hide resolved
docusaurus/docs/develop/path/path_config.md Outdated Show resolved Hide resolved
docusaurus/docs/develop/path/walkthrough.md Show resolved Hide resolved
docusaurus/docs/develop/path/walkthrough.md Outdated Show resolved Hide resolved
docusaurus/docs/develop/path/walkthrough.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/operate.md Show resolved Hide resolved
local/scripts/shannon_populate_config.sh Show resolved Hide resolved
@Olshansk
Copy link
Contributor Author

@commoddity I'm still testing + updating the PR but most of the comments you left should be addressed here: 781bcab (#137)

@Olshansk Olshansk requested a review from commoddity January 21, 2025 22:50
Copy link
Contributor Author

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

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

@commoddity PTAL again when you can!

Copy link
Contributor

@commoddity commoddity left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the changes.

@Olshansk Olshansk merged commit 7074ec4 into main Jan 21, 2025
11 checks passed
@Olshansk Olshansk deleted the e2e_improvements branch January 21, 2025 23:13
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: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants