Skip to content

Improve L1-L2 docs#726

Merged
FabijanC merged 5 commits intomainfrom
improve-l1-l2-docs
Mar 25, 2025
Merged

Improve L1-L2 docs#726
FabijanC merged 5 commits intomainfrom
improve-l1-l2-docs

Conversation

@FabijanC
Copy link
Copy Markdown
Contributor

@FabijanC FabijanC commented Mar 20, 2025 •
edited by coderabbitai bot
Loading

Usage related changes

What the title says.

Development related changes

N/A

Checklist:

  • Checked out the contribution guidelines
  • Applied formatting - ./scripts/format.sh
  • No linter errors - ./scripts/clippy_check.sh
  • No unused dependencies - ./scripts/check_unused_deps.sh
  • No spelling errors - ./scripts/check_spelling.sh
  • Performed code self-review
  • Rebased to the latest commit of the target branch (or merged it into my branch)
    • Once you make the PR reviewable, please avoid force-pushing
  • Updated the docs if needed - ./website/README.md
  • Linked the issues resolvable by this PR - linking info
  • Updated the tests if needed; all passing - execution info

Summary by CodeRabbit

  • Documentation
    • Revised the Postman utility guide for improved clarity and detail.
    • Structured prerequisites into a bulleted list outlining required components for L1-L2 interaction.
    • Expanded explanations for the network_url parameter and configurations for L1-L2 communication in Docker.
    • Highlighted the optional nature of the address parameter in the JSON request.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 20, 2025 •
edited
Loading

Walkthrough

The documentation in postman.md was updated to provide clearer and more detailed instructions for using the Postman utility in L1-L2 interactions. A single sentence was replaced with a bulleted list detailing required components such as the L1 node, Devnet instance, and related messaging contracts. The explanation for the network_url parameter was expanded, and the optional address parameter now includes clarifying comments.

Changes

File(s) Change Summary
website/docs/postman.md Replaced a single prerequisite sentence with a detailed bulleted list of required components; expanded details on network_url and the optional address parameter.

Suggested reviewers

  • marioiordanov

Poem

I’m a bunny hopping along the code trail,
Skipping through docs with a rhythmic tale.
Updated steps in a joyful dance,
In precise docs, clarity finds its chance.
Hoppin' and celebratin'—let's never fail!
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d47ff0c and 8409aa3.

📒 Files selected for processing (1)
  • website/docs/postman.md (3 hunks)
🔇 Additional comments (7)
website/docs/postman.md (7)

3-3: Clear Introduction Clarifies Postman Utility.
The introductory sentence now clearly distinguishes the Starknet Postman utility from the Postman API platform, which helps prevent any potential confusion for users.

5-11: Enhanced Prerequisites List Improves Readability.
Converting the prerequisites into a structured bulleted list makes the required components much easier to follow. The detailed breakdown (including sub-points for the messaging contract) clearly guides users on what is needed before using the utility.

13-13: Concise Explanation of Message Queues.
The added description provides a clear rationale for the flushing step by explaining that there are two internal message queues (L1→L2 and L2→L1). This is helpful for setting correct expectations.

15-15: Useful Reference to Helper Library and Example.
The expanded paragraph that points to starknet-devnet-js and the related test example adds valuable context for users looking for practical application guidelines.

26-26: Clarification of Optional Parameter in JSON.
Annotating the "address" parameter as optional in the JSON request is a nice touch that improves usability. It clearly informs users that specifying an address is not mandatory if they prefer to deploy a new instance.

43-49: Informative Note on Dockerized Devnet Configurations.
The note block regarding L1-L2 communication when running Devnet in a Docker container is very useful. It offers specific instructions for Linux as well as for Mac and Windows environments. This added clarity should help users avoid common network misconfigurations.

56-62: Expanded Explanation of the network_url Parameter.
The updated description of the network_url parameter, along with the comprehensive list of supported L1 node options, significantly enhances the document's clarity and user guidance.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Mar 20, 2025
View reviewed changes
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
website/docs/postman.md (1)

45-47: L1 Network section header and description clarity
The new "### L1 network" header and the expanded description of the network_url parameter clearly explain that it should point to the JSON-RPC API endpoint of the L1 node.
Suggestion: Consider adding a comma after "locally" (e.g., "L1 node you've run locally, or which is publicly accessible") to further improve readability.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~47-~47: Possible missing comma found.
Context: ... of the JSON-RPC API endpoint of the L1 node you've run locally or which is publicly...

(AI_HYDRA_LEO_MISSING_COMMA)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fef38cc and 676a4f5.

📒 Files selected for processing (1)
  • website/docs/postman.md (3 hunks)
🧰 Additional context used
🪛 LanguageTool
website/docs/postman.md

[uncategorized] ~47-~47: Possible missing comma found.
Context: ... of the JSON-RPC API endpoint of the L1 node you've run locally or which is publicly...

(AI_HYDRA_LEO_MISSING_COMMA)

🔇 Additional comments (6)
website/docs/postman.md (6)

3-3: Clear introduction update for Postman description
The updated sentence clearly distinguishes the Starknet Postman utility (used for L1–L2 interaction) from the Postman API platform, which should help reduce user confusion.

5-11: Enhanced prerequisites listing with bullet points
The new bulleted list neatly itemizes all required components (L1 node, Devnet instance, messaging contract, etc.), greatly improving the clarity and readability over the previous single-sentence description.

13-13: Explicit explanation of internal message queues
The update succinctly explains the existence of two message queues (L1→L2 and L2→L1) and clearly instructs users to flush the queues when messages are present. This clarification is beneficial for proper test setup and debugging.

15-15: Improved guidance for using starknet-devnet-js
Expanding on the available testing options—including a direct reference to an example test case—provides valuable guidance for users who might be unfamiliar with the utility.

26-26: Clarification in JSON snippet for optional parameter
Adding the inline comment // optional to the "address" field enhances clarity regarding its optional nature in the configuration.

49-54: Comprehensive list of L1 network options
The updated list provides multiple, clearly formatted examples (Anvil, Sepolia, Ganache, Geth, Hardhat node) which will help users identify the right tool for their setup.

@FabijanC FabijanC merged commit d49b605 into main Mar 25, 2025
1 check passed
@FabijanC FabijanC deleted the improve-l1-l2-docs branch March 25, 2025 10:26
@coderabbitai coderabbitai bot mentioned this pull request Apr 1, 2025
Merged
10 tasks
@coderabbitai coderabbitai bot mentioned this pull request May 26, 2025
Merged
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@FabijanC