Skip to content

docs: docs for bridges, Layer2s, adjustments in general and mermaid style#68

Merged
oxlumi merged 9 commits intodevfrom
docs/research-missing-articles
Aug 22, 2025
Merged

docs: docs for bridges, Layer2s, adjustments in general and mermaid style#68
oxlumi merged 9 commits intodevfrom
docs/research-missing-articles

Conversation

@oxlumi
Copy link
Copy Markdown
Member

@oxlumi oxlumi commented Jul 22, 2025

This PR includes documentation for bridges, general adjustments, and updates to mermaid style (I installed mermaid to the handbook, please check that)

Summary by CodeRabbit

  • New Features

    • Enabled and customized Mermaid diagram support with Wonderland-themed colors and styles for improved visual consistency across diagrams.
  • Documentation

    • Completely rewrote and expanded the blockchain bridges knowledge base article, providing a comprehensive guide with detailed explanations, real-world examples, and references.
    • Completely rewrote and expanded the Layer 2 documentation with detailed explanations, architecture diagrams, and future outlook.
    • Improved punctuation, formatting, and stylistic consistency across multiple documentation files for better clarity and readability.
  • Style

    • Applied Wonderland branding and enhanced readability to Mermaid diagrams through updated CSS.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jul 22, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
handbook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 6, 2025 3:00pm
op-handbook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 6, 2025 3:00pm

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 22, 2025

📝 Walkthrough

Walkthrough

This pull request introduces a variety of changes across the Wonderland documentation and configuration. The majority of the changes are minor textual and formatting edits, primarily replacing em dashes with colons or commas for improved readability and consistency throughout several markdown documentation files. One significant update is a complete rewrite and expansion of the "Bridges" knowledge base article, transforming it from a placeholder into a comprehensive guide covering bridge types, security, mechanisms, and future trends. Another major rewrite expands the "Layer 2" knowledge base article into a detailed exposition on L2 blockchain scaling solutions, covering architecture, trust models, economic mechanisms, and future directions. Additionally, the Docusaurus configuration is updated to enable and theme Mermaid diagrams, including the addition of custom Mermaid styling in the CSS to align diagrams with the Wonderland brand.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~50 minutes

Possibly related PRs

  • fix: grammar issues #64: Focuses on similar minor textual and punctuation corrections in documentation, specifically replacing em dashes with colons or commas, which aligns with many of the stylistic changes in this PR.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/research-missing-articles

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.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
  • 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 explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests 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.

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.

Copy link
Copy Markdown
Contributor

@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: 6

🔭 Outside diff range comments (1)
sites/wonderland/docs/development/research/onboarding/knowledge-base/basics/game-theory.md (1)

412-415: Typo: “befcause” → “because”

-Imperfect information games introduce strategic uncertainty befcause players …
+Imperfect information games introduce strategic uncertainty because players …
🧹 Nitpick comments (9)
sites/wonderland/docs/development/research/onboarding/overview.md (1)

15-15: Drop “sort of” to tighten tone.
The phrase slightly undermines authority. Consider:

-In essence, we are sort of the foundation of every project, which is why we exist:
+In essence, we are the foundation of every project, which is why we exist:
sites/wonderland/docs/development/research/onboarding/knowledge-base/basics/game-theory.md (2)

34-35: Fix missing space after comma to improve readability

payoffs,somepayoffs, some

-Without payoffs,some sense of objectives (self-interest, collective good, moral satisfaction), we can't analyze the situation properly.
+Without payoffs, some sense of objectives (self-interest, collective good, moral satisfaction), we can't analyze the situation properly.

125-126: Avoid duplicated adverb – one “strictly” is enough

-A **strictly dominant strategy** yields a _strictly higher_ payoff …
+A **strictly dominant strategy** yields a _higher_ payoff …
sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/amm.md (2)

70-71: Sentence now reads awkwardly after the rewrite

…, essentially reserving preferential treatment and capturing arbitrage returns…

Consider dropping “essentially” or moving it:

-…, essentially reserving preferential treatment and capturing arbitrage returns…
+…, reserving preferential treatment and capturing arbitrage returns…

168-171: Convert bare URLs to Markdown links

Markdown-lint flags the two bare URLs just added.
Example fix:

-https://www.machow.ski/posts/an_introduction_to_automated_market_makers/ - **MUST read. Awesome article.**
+[An Introduction to Automated Market Makers](https://www.machow.ski/posts/an_introduction_to_automated_market_makers/) – **must read, awesome article.**

Same for the RareSkills link.

sites/wonderland/src/css/local.css (1)

146-152: Heavy use of !important may fight Docusaurus dark/light themes

Over-scoping every Mermaid rule with !important prevents downstream overrides (e.g. dark-mode adjustments).
Consider tightening selectors and removing !important where not strictly required.

sites/wonderland/docs/development/research/onboarding/knowledge-base/core/evm.md (2)

52-55: Punctuation cleanup around “OOG” parenthetical

Current: an OOG ,Out of Gas, exception

-an OOG ,Out of Gas, exception
+an “out-of-gas” (OOG) exception

67-68: Missing space after comma

"launched and run somewhere else"_,they"launched and run somewhere else"_, they

sites/wonderland/docs/development/research/onboarding/knowledge-base/core/oracles.md (1)

69-70: Use a single spelling variant – “subsidize”

The document mixes subsidise and subsidize. Stick to one (usually US English in the repo).

-…continue to subsidise node operators…
+…continue to subsidize node operators…
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f3796c4 and 14bdd37.

📒 Files selected for processing (17)
  • sites/wonderland/docs/development/research/onboarding/challenges/basic/game-theory.md (1 hunks)
  • sites/wonderland/docs/development/research/onboarding/challenges/basic/tokenomics.md (1 hunks)
  • sites/wonderland/docs/development/research/onboarding/challenges/defi/defi.md (1 hunks)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/basics/game-theory.md (21 hunks)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/core/bridges.md (1 hunks)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/core/evm.md (8 hunks)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/core/layer_2.md (1 hunks)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/core/oracles.md (3 hunks)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/amm.md (4 hunks)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/lending-protocol.md (2 hunks)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/limit-order.md (1 hunks)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/intermediate/cryptography.md (1 hunks)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/intermediate/solidity.md (2 hunks)
  • sites/wonderland/docs/development/research/onboarding/overview.md (2 hunks)
  • sites/wonderland/docs/development/research/technical-writing.md (4 hunks)
  • sites/wonderland/docusaurus.config.ts (2 hunks)
  • sites/wonderland/src/css/local.css (1 hunks)
🧠 Learnings (1)
sites/wonderland/docusaurus.config.ts (1)

Learnt from: th0rOdinson
PR: #46
File: sites/template/docusaurus.config.ts:70-70
Timestamp: 2025-07-03T21:13:49.173Z
Learning: In the defi-wonderland/handbook repository, when using webpack-merge to merge configurations in Docusaurus config files, the commonConfig is typed as Partial and localConfig is typed as Config. This means that merge(commonConfig, localConfig) maintains type safety without needing explicit type assertions, as TypeScript properly handles the merge of a partial configuration with a full configuration.

🪛 markdownlint-cli2 (0.17.2)
sites/wonderland/docs/development/research/onboarding/knowledge-base/core/layer_2.md

6-6: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

sites/wonderland/docs/development/research/onboarding/knowledge-base/basics/game-theory.md

520-520: Bare URL used

(MD034, no-bare-urls)

sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/amm.md

168-168: Bare URL used

(MD034, no-bare-urls)


170-170: Bare URL used

(MD034, no-bare-urls)

sites/wonderland/docs/development/research/onboarding/knowledge-base/core/evm.md

52-52: Bare URL used

(MD034, no-bare-urls)


61-61: Bare URL used

(MD034, no-bare-urls)


62-62: Bare URL used

(MD034, no-bare-urls)

sites/wonderland/docs/development/research/onboarding/knowledge-base/core/bridges.md

22-22: Bare URL used

(MD034, no-bare-urls)


73-73: Bare URL used

(MD034, no-bare-urls)


101-101: Bare URL used

(MD034, no-bare-urls)


133-133: Bare URL used

(MD034, no-bare-urls)


170-170: Bare URL used

(MD034, no-bare-urls)


260-260: Bare URL used

(MD034, no-bare-urls)


260-260: Bare URL used

(MD034, no-bare-urls)


271-271: Bare URL used

(MD034, no-bare-urls)


282-282: Bare URL used

(MD034, no-bare-urls)


292-292: Bare URL used

(MD034, no-bare-urls)


300-300: Bare URL used

(MD034, no-bare-urls)


305-305: Bare URL used

(MD034, no-bare-urls)

🪛 LanguageTool
sites/wonderland/docs/development/research/onboarding/knowledge-base/basics/game-theory.md

[style] ~5-~5: Consider a more expressive alternative.
Context: ... it's about aligning incentives. To do that, calculating the costs of attacks,...

(DO_ACHIEVE)


[style] ~115-~115: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...icken." - If both hold, they crash, a very bad payoff for both. <div style={{textAlig...

(EN_WEAK_ADJECTIVE)


[style] ~125-~125: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...strictly dominant strategy* yields a strictly higher payoff than any other choice _n...

(ADVERB_REPETITION_PREMIUM)

sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/lending-protocol.md

[grammar] ~29-~29: Ensure spelling is correct
Context: ...ralization ratio, or a maximum loan-to-valuo (LTV). When a user supplies assets to ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/amm.md

[style] ~170-~170: Consider a different adverb to strengthen your wording.
Context: ...s://www.rareskills.io/uniswap-v2-book - Really recommended. Lau, D., Wong, D., Chan, ...

(REALLY_STRONGLY)

sites/wonderland/docs/development/research/onboarding/overview.md

[style] ~15-~15: To make your writing sound more confident, consider removing the phrase ‘sort of’.
Context: ...th recommendations. In essence, we are sort of the foundation of every project, which is w...

(SORT_OF_NP)

sites/wonderland/docs/development/research/onboarding/knowledge-base/core/oracles.md

[uncategorized] ~69-~69: Do not mix variants of the same word (‘subsidize’ and ‘subsidise’) within a single text.
Context: ...ing on a single company or multi-sig to subsidize node operators. No additional token is ...

(EN_WORD_COHERENCY)

sites/wonderland/docs/development/research/onboarding/knowledge-base/core/bridges.md

[style] ~61-~61: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...moving assets to/from Ethereum uses the exact same security model that secures the L2 itse...

(EN_WORDINESS_PREMIUM_EXACT_SAME)


[style] ~120-~120: ‘completely destroyed’ might be wordy. Consider a shorter alternative.
Context: ... is a cleaner approach where tokens are completely destroyed on the source chain and brand new nativ...

(EN_WORDINESS_PREMIUM_COMPLETELY_DESTROYED)


[style] ~293-~293: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... transaction? How much would that cost? How are the private keys managed? Is there ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🪛 Biome (1.9.4)
sites/wonderland/docusaurus.config.ts

[error] 74-74: This property value named primaryTextColor is later overwritten by an object member with the same name.

Overwritten with this value.

If an object property with the same name is defined multiple times (except when combining a getter with a setter), only the last definition makes it into the object and previous definitions are ignored.
Unsafe fix: Remove this property value named primaryTextColor

(lint/suspicious/noDuplicateObjectKeys)

🧰 Additional context used
🧠 Learnings (1)
sites/wonderland/docusaurus.config.ts (1)

Learnt from: th0rOdinson
PR: #46
File: sites/template/docusaurus.config.ts:70-70
Timestamp: 2025-07-03T21:13:49.173Z
Learning: In the defi-wonderland/handbook repository, when using webpack-merge to merge configurations in Docusaurus config files, the commonConfig is typed as Partial and localConfig is typed as Config. This means that merge(commonConfig, localConfig) maintains type safety without needing explicit type assertions, as TypeScript properly handles the merge of a partial configuration with a full configuration.

🪛 markdownlint-cli2 (0.17.2)
sites/wonderland/docs/development/research/onboarding/knowledge-base/core/layer_2.md

6-6: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

sites/wonderland/docs/development/research/onboarding/knowledge-base/basics/game-theory.md

520-520: Bare URL used

(MD034, no-bare-urls)

sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/amm.md

168-168: Bare URL used

(MD034, no-bare-urls)


170-170: Bare URL used

(MD034, no-bare-urls)

sites/wonderland/docs/development/research/onboarding/knowledge-base/core/evm.md

52-52: Bare URL used

(MD034, no-bare-urls)


61-61: Bare URL used

(MD034, no-bare-urls)


62-62: Bare URL used

(MD034, no-bare-urls)

sites/wonderland/docs/development/research/onboarding/knowledge-base/core/bridges.md

22-22: Bare URL used

(MD034, no-bare-urls)


73-73: Bare URL used

(MD034, no-bare-urls)


101-101: Bare URL used

(MD034, no-bare-urls)


133-133: Bare URL used

(MD034, no-bare-urls)


170-170: Bare URL used

(MD034, no-bare-urls)


260-260: Bare URL used

(MD034, no-bare-urls)


260-260: Bare URL used

(MD034, no-bare-urls)


271-271: Bare URL used

(MD034, no-bare-urls)


282-282: Bare URL used

(MD034, no-bare-urls)


292-292: Bare URL used

(MD034, no-bare-urls)


300-300: Bare URL used

(MD034, no-bare-urls)


305-305: Bare URL used

(MD034, no-bare-urls)

🪛 LanguageTool
sites/wonderland/docs/development/research/onboarding/knowledge-base/basics/game-theory.md

[style] ~5-~5: Consider a more expressive alternative.
Context: ... it's about aligning incentives. To do that, calculating the costs of attacks,...

(DO_ACHIEVE)


[style] ~115-~115: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...icken." - If both hold, they crash, a very bad payoff for both. <div style={{textAlig...

(EN_WEAK_ADJECTIVE)


[style] ~125-~125: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...strictly dominant strategy* yields a strictly higher payoff than any other choice _n...

(ADVERB_REPETITION_PREMIUM)

sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/lending-protocol.md

[grammar] ~29-~29: Ensure spelling is correct
Context: ...ralization ratio, or a maximum loan-to-valuo (LTV). When a user supplies assets to ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/amm.md

[style] ~170-~170: Consider a different adverb to strengthen your wording.
Context: ...s://www.rareskills.io/uniswap-v2-book - Really recommended. Lau, D., Wong, D., Chan, ...

(REALLY_STRONGLY)

sites/wonderland/docs/development/research/onboarding/overview.md

[style] ~15-~15: To make your writing sound more confident, consider removing the phrase ‘sort of’.
Context: ...th recommendations. In essence, we are sort of the foundation of every project, which is w...

(SORT_OF_NP)

sites/wonderland/docs/development/research/onboarding/knowledge-base/core/oracles.md

[uncategorized] ~69-~69: Do not mix variants of the same word (‘subsidize’ and ‘subsidise’) within a single text.
Context: ...ing on a single company or multi-sig to subsidize node operators. No additional token is ...

(EN_WORD_COHERENCY)

sites/wonderland/docs/development/research/onboarding/knowledge-base/core/bridges.md

[style] ~61-~61: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...moving assets to/from Ethereum uses the exact same security model that secures the L2 itse...

(EN_WORDINESS_PREMIUM_EXACT_SAME)


[style] ~120-~120: ‘completely destroyed’ might be wordy. Consider a shorter alternative.
Context: ... is a cleaner approach where tokens are completely destroyed on the source chain and brand new nativ...

(EN_WORDINESS_PREMIUM_COMPLETELY_DESTROYED)


[style] ~293-~293: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... transaction? How much would that cost? How are the private keys managed? Is there ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🪛 Biome (1.9.4)
sites/wonderland/docusaurus.config.ts

[error] 74-74: This property value named primaryTextColor is later overwritten by an object member with the same name.

Overwritten with this value.

If an object property with the same name is defined multiple times (except when combining a getter with a setter), only the last definition makes it into the object and previous definitions are ignored.
Unsafe fix: Remove this property value named primaryTextColor

(lint/suspicious/noDuplicateObjectKeys)

🔇 Additional comments (16)
sites/wonderland/docs/development/research/onboarding/knowledge-base/intermediate/cryptography.md (1)

9-9: Punctuation tweak reads better – good catch.
Replacing the em-dashes with commas removes visual noise and keeps the sentence flowing naturally. No further action needed.

sites/wonderland/docs/development/research/onboarding/challenges/basic/game-theory.md (1)

87-87: Colon is the right choice here – clear and concise.
The edit tightens the submission instruction and aligns with the broader style sweep. Looks good.

sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/limit-order.md (1)

124-124: Comma improves readability – LGTM.
No further comments.

sites/wonderland/docs/development/research/onboarding/challenges/basic/tokenomics.md (1)

42-42: Consistent punctuation update accepted.
The colon clarifies the instruction and matches the neighbouring docs.

sites/wonderland/docs/development/research/onboarding/overview.md (2)

23-24: Nice re-punctuation – reads smoother.
The comma splits the sentence properly and keeps the onboarding intro energetic.


33-34: Colon fits better than the dash – good update.
No further issues.

sites/wonderland/docs/development/research/technical-writing.md (1)

10-10: Phrasing looks good – no action needed.
The rewritten sentence flows better and preserves the original meaning.

sites/wonderland/docs/development/research/onboarding/challenges/defi/defi.md (1)

54-55: Hyphen replacement is fine.
The change keeps the heading readable and consistent with the rest of the docs.

sites/wonderland/docs/development/research/onboarding/knowledge-base/intermediate/solidity.md (1)

29-30: Header is clear – no issues.
Just noting that the optional section heading renders correctly after the earlier fix.

sites/wonderland/docs/development/research/onboarding/knowledge-base/basics/game-theory.md (1)

159-162: Insert spaces after commas for consistency

There are several occurrences like process,in and become strictly dominated as well,so we that miss a space after the comma.
Consider a quick global sweep on the changed lines to keep the prose polished.

sites/wonderland/docusaurus.config.ts (1)

50-54: LGTM! Mermaid integration properly configured.

The markdown configuration correctly enables Mermaid support and the theme is properly added. This should allow Mermaid diagrams to render in documentation files.

sites/wonderland/docs/development/research/onboarding/knowledge-base/core/bridges.md (5)

81-106: Excellent Mermaid diagram implementation.

The lock-and-mint sequence diagram is well-structured and clearly illustrates the bridge flow. The syntax is correct and should render properly with the Mermaid configuration.


122-140: Well-designed burn-and-mint flow diagram.

The sequence diagram effectively demonstrates the burn-and-mint mechanism with proper participant relationships and clear step numbering.


159-182: Intent-based bridge diagram captures complex flow well.

The diagram successfully illustrates the sophisticated intent-based bridging mechanism with competitive relayers and settlement verification. The multi-step process is clearly visualized.


200-221: Liquidity pool diagram completes the bridge mechanism coverage.

The final sequence diagram effectively shows the liquidity pool approach with rebalancing mechanics. All four Mermaid diagrams together provide comprehensive visual coverage of bridge mechanisms.


1-359: Outstanding comprehensive bridges documentation.

This is an exceptional technical document that transforms a placeholder into a thorough, well-researched guide covering all major aspects of blockchain bridges. The content is:

  • Technically accurate with proper explanations of complex concepts
  • Well-structured with logical flow from fundamentals to advanced topics
  • Enhanced with excellent Mermaid diagrams that complement the text
  • Supported by authoritative references and additional resources
  • Comprehensive in scope while remaining accessible

The integration of Mermaid diagrams significantly improves the educational value by visually representing complex cross-chain flows.

Note on static analysis suggestions: The markdown linting warnings about bare URLs are acceptable in this context as they're used within explanatory text rather than as clickable links. The style suggestions about wordiness are minor and don't impact technical accuracy.

Comment thread sites/wonderland/docusaurus.config.ts
Comment thread sites/wonderland/src/css/local.css Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Lumi <lumi@wonderland.xyz>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Lumi <lumi@wonderland.xyz>
oxlumi and others added 2 commits July 28, 2025 09:47
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Lumi <lumi@wonderland.xyz>
Copy link
Copy Markdown
Contributor

@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 (2)
sites/wonderland/docs/development/research/onboarding/knowledge-base/core/oracles.md (2)

45-46: Clarify and tighten the MakerDAO sentence

The clause order makes the sentence hard to parse. Re-phrasing improves readability without changing meaning.

-[**MakerDAO’s**](https://docs.makerdao.com/smart-contract-modules/oracle-module), now Sky, oracle system, used to price collateral for DAI issuance, **was** also popular. 
+[**MakerDAO’s**](https://docs.makerdao.com/smart-contract-modules/oracle-module), now called the Sky oracle system and used to price collateral for DAI issuance, **was** also popular.

66-68: Unify spelling and hyphenation for consistency

Earlier in the doc you use the British spelling “subsidises” and the term “multisig”. Stick to one variant and one form throughout.

-It is entirely **permissionless**, meaning that any user can add a **WETH–TOKEN** pair to bootstrap a new feed. Because it uses the existing Uniswap framework, it inherits that ecosystem’s decentralization rather than relying on a single company or multi-sig to subsidize node operators. 
+It is entirely **permissionless**, meaning that any user can add a **WETH–TOKEN** pair to bootstrap a new feed. Because it uses the existing Uniswap framework, it inherits that ecosystem’s decentralisation rather than relying on a single company or multisig to subsidise node operators. 
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dec7509 and 157b1ca.

📒 Files selected for processing (1)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/core/oracles.md (3 hunks)
🧰 Additional context used
🪛 LanguageTool
sites/wonderland/docs/development/research/onboarding/knowledge-base/core/oracles.md

[uncategorized] ~68-~68: Do not mix variants of the same word (‘subsidize’ and ‘subsidise’) within a single text.
Context: ...ing on a single company or multi-sig to subsidize node operators. No additional token is ...

(EN_WORD_COHERENCY)

…efi-wonderland/handbook into docs/research-missing-articles

fix: merge changes locally
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Lumi <lumi@wonderland.xyz>
Copy link
Copy Markdown
Contributor

@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 (4)
sites/wonderland/docs/development/research/onboarding/knowledge-base/core/layer_2.md (4)

14-16: Consistent “off-chain” spelling improves clarity

“offchain” is used here and in multiple later paragraphs; elsewhere in the handbook we normally write “off-chain”.
Search-replace for consistency (first occurrence highlighted).


27-38: Add short alt-text caption for the Mermaid diagram

Screen-reader users will receive an empty code block unless we provide context.
Append a comment line directly above the triple-backtick, e.g.:

<!-- mermaid: High-level L1/L2 architecture -->

60-67: Cite the quoted numbers and Buterin article with inline links

Lines reference Vitalik’s post and ETH burn figures without a source.
Adding footnote-style links prevents future confusion and helps maintain accuracy when numbers are updated.


130-138: Minor grammar: drop the second “also”

“Based rollups also offer … but it may also introduce …” – the repetition is unnecessary.

- but it may also introduce latency
+ but it may introduce latency
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 157b1ca and fc94a19.

📒 Files selected for processing (4)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/core/layer_2.md (1 hunks)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/lending-protocol.md (2 hunks)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/intermediate/solidity.md (2 hunks)
  • sites/wonderland/docusaurus.config.ts (2 hunks)
✅ Files skipped from review due to trivial changes (3)
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/intermediate/solidity.md
  • sites/wonderland/docusaurus.config.ts
  • sites/wonderland/docs/development/research/onboarding/knowledge-base/defi/lending-protocol.md
🧰 Additional context used
🪛 LanguageTool
sites/wonderland/docs/development/research/onboarding/knowledge-base/core/layer_2.md

[grammar] ~14-~14: Ensure spelling is correct
Context: ... L2s, most transaction processing occurs offchain while still deriving security guarantee...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~23-~23: Ensure spelling is correct
Context: ...dge validity proofs, can reliably secure offchain computation. 3. **Separation of Concer...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~42-~42: Ensure spelling is correct
Context: ...tial mechanic: transactions are executed offchain but "rolled up" and committed to the L1...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~46-~46: Ensure spelling is correct
Context: ... transactions, a rollup can execute them offchain and submit a single, compressed transac...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (1)
sites/wonderland/docs/development/research/onboarding/knowledge-base/core/layer_2.md (1)

70-78: Verify TPS calculations before publication

The derived 174 TPS and 463–926 TPS ceilings depend on several fast-moving assumptions (blob size, compression ratio).
Please double-check the math or add “approx.” to avoid later corrections.

@oxlumi oxlumi requested review from 0xMonoAx and euler0x and removed request for Joxess August 22, 2025 14:46
@oxlumi oxlumi removed the request for review from 0xLeopoldo August 22, 2025 14:46
@oxlumi oxlumi merged commit fa5e8c8 into dev Aug 22, 2025
5 checks passed
@oxlumi oxlumi deleted the docs/research-missing-articles branch August 22, 2025 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants