stack/devnet: cast command is changed after 1.0 #1462
Conversation
Signed-off-by: jsvisa <[email protected]>
Signed-off-by: jsvisa <[email protected]>
Signed-off-by: jsvisa <[email protected]>
Signed-off-by: jsvisa <[email protected]>
|
@sbvegan PTAL |
✅ Deploy Preview for docs-optimism ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes update the documentation in the Suggested labels
Suggested reviewers
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
pages/stack/dev-net.mdx (1)
1-5: Missing required frontmatter metadata fieldsThe frontmatter on lines 1–5 only includes
title,lang, anddescription. For regular pages, the metadata should also includetopic,personas,categories, andcontent_type. This is required to ensure consistency and proper organization of documentation. You can fix this by running:pnpm metadata-batch-cli:dry "pages/stack/dev-net.mdx"Review the changes, then run without
:dryto apply them.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/dev-net.mdx(4 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/stack/dev-net.mdx
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (3)
pages/stack/dev-net.mdx (3)
39-39: New dependency addition for "cast"The dependency table now includes an entry for [cast] with version
^1.0.0and a version check commandcast --version, which aligns with the PR objective of enforcing a minimum cast version of 1.0. Ensure that this version meets your project’s compatibility requirements.
79-81: Updated Kurtosis command to specify enclaveThe command for starting the network now includes the
--enclave op-devnetflag. This stable enclave name replaces the previous random naming, as specified in the PR objectives. Verify that all related documentation references and subsequent instructions correctly use this enclave name.
179-181: Revised cast send command for ETH transferThe command for sending ETH has been updated:
- It now uses
--mnemonic-derivation-pathinstead of--mnemonic-path.- The amount parameter has changed from
--amount "<amount in ETH>eth"to--value "<amount in ETH>ether".These changes align with the updated behavior of the
casttool in versions ≥1.0. Confirm that the provided instructions match the expected input format for users.
Signed-off-by: jsvisa <[email protected]>
Signed-off-by: jsvisa <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
pages/stack/dev-net.mdx (2)
1-5: Metadata Incomplete: Add Missing Required Fields.The frontmatter is missing several required fields for a regular page (i.e. topic, personas, categories, and content_type). Please update the metadata (for example, by running the recommended metadata-batch-cli command) so that it conforms to the documentation guidelines.
184-189: Grammar Correction in Output Description.The phrase "The output should looks like below:" should be corrected to "The output should look like the following:" to maintain proper grammar.
🧰 Tools
🪛 LanguageTool
[grammar] ~184-~184: The modal verb ‘should’ requires the verb’s base form.
Context: ...h-teku service>"The output should looks like below:blockHash ...(MD_BASEFORM)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/dev-net.mdx(4 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/stack/dev-net.mdx
🪛 LanguageTool
pages/stack/dev-net.mdx
[grammar] ~184-~184: The modal verb ‘should’ requires the verb’s base form.
Context: ...h-teku service>" The output should looks like below: blockHash ...
(MD_BASEFORM)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (3)
pages/stack/dev-net.mdx (3)
39-39: New Dependency Added: Cast.The dependency for cast has been added with version
^1.0.0. Ensure that its installation and version check instructions align with the rest of the dependency table and that it is compatible with the environment.
78-82: Updated Kurtosis Command: Enclave Specification.The command now includes the
--enclave op-devnetflag, which establishes a stable name for the enclave. Confirm that all instances referencing the previous enclave name have been updated accordingly throughout the documentation.
179-182: Revised ETH Transfer Command.The
cast sendcommand has been updated correctly to use--private-keyand the new--value "<amount in ETH>ether"option. This change properly reflects the move away from mnemonic-based inputs. Please verify that all examples and explanatory text match this update.
|
If you're looking to make more contributions. An additional PR to add a new section to this doc that provides information about accessing grafana and some high level details on the dashboards would be awesome! |
|
Oh can you also update this "You can find your node's RPC URL by running kurtosis enclave inspect " with |
Signed-off-by: jsvisa <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
pages/stack/dev-net.mdx (2)
1-5: Missing Required Metadata FieldsThe frontmatter is missing several required fields for a regular page (e.g.
topic,personas,categories, andcontent_type). Please add these fields in accordance with the metadata guidelines. For example, you can run:pnpm metadata-batch-cli:dry "pages/stack/dev-net.mdx"
182-183: Grammatical Correction in Output DescriptionThe sentence "The output should looks like below:" contains a grammatical error. Please change it to "The output should look like the one below:" to ensure proper subject–verb agreement.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~182-~182: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...h-teku service>"The output should looks like below:blockHash ...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/dev-net.mdx(4 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/stack/dev-net.mdx
🪛 LanguageTool
pages/stack/dev-net.mdx
[uncategorized] ~182-~182: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...h-teku service>" The output should looks like below: blockHash ...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (4)
pages/stack/dev-net.mdx (4)
39-39: Correct Cast Dependency DocumentationThe dependency for
casthas been correctly added with version^1.0.0and a corresponding version check command. This update correctly reflects the new requirement.
79-82: Updated Kurtosis Command with Stable Enclave NameThe updated command now includes the
--enclave op-devnetflag. This change establishes a stable enclave name as per the PR objectives and improves overall clarity.
165-167: Updated RPC URL InstructionThe instruction to fetch the node's RPC URL now uses
kurtosis enclave inspect op-devnet, which is consistent with the new deterministic enclave naming. This update is accurate.
177-180: Updatedcast sendCommand ParametersThe
cast sendcommand has been updated to use--private-keyinstead of a mnemonic-related option and now specifies the amount using--value "<amount in ETH>ether". This aligns with the PR objectives and clarifies the intended usage.
Sure, I'll go through this tutorial, and generate the results later this week. |
|
@jsvisa awesome! Other improvements I can think of:
|
the first one is easy, and for the later one I haven't used it before, will take a look. In my side, I think we should add some documents to let users know how to debug with kurtosis, such as if the rpc port is not able to connect, how to find the correct service or docker container |
Description
cast's version >= 1.0;Tests
Additional context
Metadata