-
Notifications
You must be signed in to change notification settings - Fork 54
Morph Doc Updates #95
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
Conversation
Added a comma on "To create your Morph Mainnet Safe wallet click here"
Updated the capitalization for QuickNode for consistency
1. Updated Holesky to Hoodi 2. Grammar change (“Goldsky also allow us” to “Goldsky also allows us”)
Grammar changes. (“in the progress of integrating” to “in the process of integrating”)
1. Updated content meta description ("cost0efficient" to "cost-efficient") 2. Removed Morph Pay section
Grammar changes ( “ORA empower developers” to “ORA empowers developers”)
1. Made Space ID consistent. (SpaceID vs Space ID) 2. Grammar change (“Use Case of SpaceID” to “Use Cases of Space ID.”)
Typo correction (“morph ndoe” to “Morph node”)
Updated capitalization for consistency (“morph node” should be “Morph node”)
Changed the steps format for consistency ("Step1" to "Step 1")
1. Grammar changes ("Please not" to "Please note") 2. Cleaned up links to be consistently have no trailing "/" at the end
Grammar changes ("and more fields showing as the blew" to "and more fields are shown below:")
1. Grammar change (“Sequencer network responsible” to “The Sequencer Network is responsible”) 2. Meta description typo change ("cost0efficient" to "cost-efficient) 3. Format change for consistency ("zk-proof" to "zk proof")
1. Grammar changes ("only very a few" to "only a very few") 2. Formatting change. added \ to escape math rendering ("0.51toashighas310" to "$0.51 to as high as $310") 3. Meta description edit ("cost0efficient" to "cost-efficient")
…o Morph page 1. Removed Morph Pay, Black, Platinum from core products list 2. Removed Morph Zoo and Morph Pay from the bulleted navigation list. 3. Updated meta desc ("cost0efficient" to "cost-efficient")
1. Updated the grammar/wording on the relevant section to reflect a single product only. ("Together, these products create" changed to "This product creates") & ("Morph enables this through two core products:" to "Morph enables this through:") 2. Updated meta desc ("cost0efficient" to "cost-efficient")
1. Removed the Morph Pay paragraph 2 Removed the mention from the bullets
Reverted zk-proof to zk proof to reflect other pages
1. Updated meta description ("cost0efficient" to "cost-efficient")
1. Meta description edit ("cost0efficient" to "cost-efficient") 2. Remove trailing "/" from links for consistency
WalkthroughEditing pass across documentation: typo and hyphenation fixes, capitalization, link normalization, and testnet naming updates. Removed or de-emphasized Morph Pay references, focusing on Morph Rails. Minor heading and list formatting adjustments, end-of-file newline fixes, and small grammar corrections. No code, API, or feature changes. Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🧹 Nitpick comments (4)
docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/5-blockchain-oracles.md (1)
22-22
: Tighten the colon spacing.For consistency with standard punctuation, drop the space before the colon: “here: https://…”.
docs/build-on-morph/developer-resources/node-operation/full-node/1-run-in-docker.md (1)
26-26
: Tighten the sentence around the default home path.Small grammar polish: drop the article and switch the verb so it reads more naturally.
-The command `make run-node` takes the `../mainnet` as your node's **Home** directory by default. +The command `make run-node` uses `../mainnet` as your node's **Home** directory by default.docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/1-safe-multi-signature-wallet.md (1)
16-16
: Prefer descriptive link text over “click here”.The wording “click here” fails accessibility/lint checks (MD059) and doesn’t communicate destination context. Rephrase the sentence so the linked text names the action or destination, e.g., “To create your Morph Mainnet Safe wallet, visit the onboarding portal.”
docs/build-on-morph/developer-resources/node-operation/upgrade-node/2-upgrade-node-docker.md (1)
18-18
: Tighten the Step 1 heading wording.There’s an extra space after the colon (“Step 1: Update…”) and the phrasing “docker images version” reads awkward. Consider trimming to “Step 1: Update Docker image versions” for clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (19)
docs/about-morph/0-user-navigation-page.md
(1 hunks)docs/about-morph/1-overview-of-morph.md
(1 hunks)docs/about-morph/5-morphs-vision-and-mission.md
(2 hunks)docs/about-morph/morph-rails.md
(1 hunks)docs/build-on-morph/build-on-morph/1-integration-one-page.md
(1 hunks)docs/build-on-morph/build-on-morph/2-development-setup.md
(2 hunks)docs/build-on-morph/developer-resources/1-contracts.md
(3 hunks)docs/build-on-morph/developer-resources/3-morph-json-rpc-api-methods.md
(2 hunks)docs/build-on-morph/developer-resources/node-operation/full-node/1-run-in-docker.md
(2 hunks)docs/build-on-morph/developer-resources/node-operation/full-node/2-run-on-host.md
(2 hunks)docs/build-on-morph/developer-resources/node-operation/upgrade-node/2-upgrade-node-docker.md
(2 hunks)docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/1-safe-multi-signature-wallet.md
(1 hunks)docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/2-rpc-services.md
(2 hunks)docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/4-blockchain-indexing-services.md
(1 hunks)docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/5-blockchain-oracles.md
(1 hunks)docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/7-artificial-intelligence.md
(1 hunks)docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/8-decentralized-naming-services.md
(3 hunks)docs/how-morph-works/2-morph-modular-design.md
(5 hunks)docs/how-morph-works/3-optimistic-zkevm.md
(4 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/1-safe-multi-signature-wallet.md
16-16: Link text should be descriptive
(MD059, descriptive-link-text)
docs/build-on-morph/developer-resources/1-contracts.md
23-23: Link text should be descriptive
(MD059, descriptive-link-text)
docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/4-blockchain-indexing-services.md
28-28: Link text should be descriptive
(MD059, descriptive-link-text)
docs/build-on-morph/build-on-morph/2-development-setup.md
31-31: Bare URL used
(MD034, no-bare-urls)
31-31: Bare URL used
(MD034, no-bare-urls)
34-34: Bare URL used
(MD034, no-bare-urls)
34-34: Bare URL used
(MD034, no-bare-urls)
docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/8-decentralized-naming-services.md
20-20: Link text should be descriptive
(MD059, descriptive-link-text)
🔇 Additional comments (1)
docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/7-artificial-intelligence.md (1)
13-13
: Subject-verb agreement fix looks good.The switch to “empowers” correctly matches the singular subject “ORA”. Nice cleanup.
For more information, please refer to [their documentation](https://docs.envio.dev). | ||
|
||
Click [here](https://envio.dev/explorer) for live indexer examples to be inspired. | ||
Click [here](https://envio.dev/explorer) for live indexer examples to be inspired. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replace “Click here” with descriptive link text
The markdownlint MD059 warning is valid: “Click here” is non-descriptive and hurts accessibility/readability. Please switch to descriptive anchor text.
Apply this diff:
-Click [here](https://envio.dev/explorer) for live indexer examples to be inspired.
+Explore live indexer examples in the [Envio Explorer](https://envio.dev/explorer) for inspiration.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Click [here](https://envio.dev/explorer) for live indexer examples to be inspired. | |
Explore live indexer examples in the [Envio Explorer](https://envio.dev/explorer) for inspiration. |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
28-28: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
In
docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/4-blockchain-indexing-services.md
around line 28, the anchor text "Click here" is non-descriptive and triggers
markdownlint MD059; replace it with descriptive link text such as "Live indexer
examples" (or "Live indexer examples on Envio") so the line becomes a meaningful
link to https://envio.dev/explorer, preserving the URL and punctuation.
 | ||
|
||
eOracle is currently in the progress of integrating Morph mainnet. | ||
eOracle is currently in the process of integrating Morph mainnet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add missing preposition and capitalize Mainnet.
“integrating Morph mainnet” should read “integrating with Morph Mainnet” for correct grammar and capitalization. Please update accordingly.
🤖 Prompt for AI Agents
In
docs/build-on-morph/developer-resources/use-ecosystem-developer-tools/5-blockchain-oracles.md
around line 18, the sentence "eOracle is currently in the process of integrating
Morph mainnet." is missing a preposition and has incorrect capitalization;
update it to read "eOracle is currently in the process of integrating with Morph
Mainnet." so it includes "with" and capitalizes "Mainnet."
Summary by CodeRabbit