feat: restructure developers category - #1515
Merged
Merged
Conversation
Contributor
|
Warning Rate Limit Exceeded@jcstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 25 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThe recent updates focus on enhancing the navigation and content structure within the developer sections of a documentation site. Key changes include reorganizing rollup categories, updating links, and adding new sections for various blockchain technologies and frameworks, aimed at providing clearer pathways and richer information for developers. Changes
Assessment against linked issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
Contributor
|
Bidon15
reviewed
Apr 11, 2024
Bidon15
approved these changes
Apr 11, 2024
jcstein
marked this pull request as ready for review
April 11, 2024 16:30
![coderabbitai[bot]](https://avatars.github.com/in/347564?s=60&v=4){kind=small}
Merged
jcstein
commented
Apr 11, 2024
jcstein
commented
Apr 11, 2024
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
Actionable comments outside the diff hunks (2)
developers/build-whatever.md (2)
Line range hint
71-71: A comma might be missing here. Consider revising for clarity.- With blockchains there are more or less four core functions that they do. + With blockchains, there are more or less four core functions that they do.
Line range hint
116-116: Unpaired symbol: ‘[’ seems to be missing. Ensure that the markdown syntax for links is correctly formatted.- [Data availability sampling](https://celestia.org/glossary/data-availability-sampling/) + [Data availability sampling](https://celestia.org/glossary/data-availability-sampling/)
Comment on lines
+27
to
+28
| import UrlImageButton from '../.vitepress/components/UrlImageButton.vue'; | ||
| </script> |
Contributor
There was a problem hiding this comment.
Consider using a more reliable relative path for importing the UrlImageButton.vue component. Given the previous issues with path resolution, here's an updated suggestion:
- import UrlImageButton from '../.vitepress/components/UrlImageButton.vue';
+ import UrlImageButton from '../../components/UrlImageButton.vue';This assumes that your components directory is two levels up from the location of your Markdown file. If this path does not work, please provide the correct relative path from your Markdown file to the UrlImageButton.vue component to ensure the path is accurate for your project's structure.
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.
Suggested change
| import UrlImageButton from '../.vitepress/components/UrlImageButton.vue'; | |
| </script> | |
| import UrlImageButton from '../../components/UrlImageButton.vue'; | |
| </script> |
Comment on lines
+33
to
+40
| <div style="display: flex; flex-wrap: wrap; justify-content: center; align-items: center; grid-template-columns: repeat(auto-fill, minmax(150px, 1fr)); gap: 20px;"> | ||
| <UrlImageButton url="/developers/intro-to-op-stack" imageSrc="/build/opstack.webp" text="OP Stack" notes="EVM" target="_self" alt="OP Stack logo" aria-label="OP Stack"/> | ||
| <UrlImageButton url="/developers/arbitrum-integration" imageSrc="/build/arbitrum.webp" text="Arbitrum Orbit" notes="EVM" target="_self" alt="Arbitrum logo" aria-label="Arbitrum"/> | ||
| <UrlImageButton url="/developers/build-whatever" imageSrc="/build/polygon.webp" text="Polygon CDK" target="_self" notes="EVM: Coming soon" alt="Polygon logo" aria-label="Polygon"/> | ||
| <UrlImageButton url="https://github.com/Sovereign-Labs/sovereign-sdk/tree/stable/examples/demo-rollup#demo-rollup" imageSrc="/build/sovereign.webp" text="Sovereign SDK" notes="Sovereign" alt="Sovereign logo" aria-label="Sovereign"/> | ||
| <UrlImageButton url="https://docs.dymension.xyz/build/overview/" imageSrc="/build/dymension.webp" text="Dymension" alt="Dymension logo" aria-label="Dymension"/> | ||
| <UrlImageButton url="https://rollkit.dev" imageSrc="/build/rollkit.webp" text="Rollkit" notes="Sovereign" alt="Rollkit logo" aria-label="Rollkit"/> | ||
| </div> |
Contributor
There was a problem hiding this comment.
Ensure accessibility by adding alt attributes to images and appropriate ARIA labels to interactive elements. It's great to see that alt attributes are already included. However, consider adding ARIA labels to enhance accessibility further.
+ <UrlImageButton url="/developers/intro-to-op-stack" imageSrc="/build/opstack.webp" text="OP Stack" notes="EVM" target="_self" alt="OP Stack logo" aria-label="OP Stack"/>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.
Suggested change
| <div style="display: flex; flex-wrap: wrap; justify-content: center; align-items: center; grid-template-columns: repeat(auto-fill, minmax(150px, 1fr)); gap: 20px;"> | |
| <UrlImageButton url="/developers/intro-to-op-stack" imageSrc="/build/opstack.webp" text="OP Stack" notes="EVM" target="_self" alt="OP Stack logo" aria-label="OP Stack"/> | |
| <UrlImageButton url="/developers/arbitrum-integration" imageSrc="/build/arbitrum.webp" text="Arbitrum Orbit" notes="EVM" target="_self" alt="Arbitrum logo" aria-label="Arbitrum"/> | |
| <UrlImageButton url="/developers/build-whatever" imageSrc="/build/polygon.webp" text="Polygon CDK" target="_self" notes="EVM: Coming soon" alt="Polygon logo" aria-label="Polygon"/> | |
| <UrlImageButton url="https://github.com/Sovereign-Labs/sovereign-sdk/tree/stable/examples/demo-rollup#demo-rollup" imageSrc="/build/sovereign.webp" text="Sovereign SDK" notes="Sovereign" alt="Sovereign logo" aria-label="Sovereign"/> | |
| <UrlImageButton url="https://docs.dymension.xyz/build/overview/" imageSrc="/build/dymension.webp" text="Dymension" alt="Dymension logo" aria-label="Dymension"/> | |
| <UrlImageButton url="https://rollkit.dev" imageSrc="/build/rollkit.webp" text="Rollkit" notes="Sovereign" alt="Rollkit logo" aria-label="Rollkit"/> | |
| </div> | |
| <div style="display: flex; flex-wrap: wrap; justify-content: center; align-items: center; grid-template-columns: repeat(auto-fill, minmax(150px, 1fr)); gap: 20px;"> | |
| <UrlImageButton url="/developers/intro-to-op-stack" imageSrc="/build/opstack.webp" text="OP Stack" notes="EVM" target="_self" alt="OP Stack logo" aria-label="OP Stack"/> | |
| <UrlImageButton url="/developers/arbitrum-integration" imageSrc="/build/arbitrum.webp" text="Arbitrum Orbit" notes="EVM" target="_self" alt="Arbitrum logo" aria-label="Arbitrum"/> | |
| <UrlImageButton url="/developers/build-whatever" imageSrc="/build/polygon.webp" text="Polygon CDK" target="_self" notes="EVM: Coming soon" alt="Polygon logo" aria-label="Polygon"/> | |
| <UrlImageButton url="https://github.com/Sovereign-Labs/sovereign-sdk/tree/stable/examples/demo-rollup#demo-rollup" imageSrc="/build/sovereign.webp" text="Sovereign SDK" notes="Sovereign" alt="Sovereign logo" aria-label="Sovereign"/> | |
| <UrlImageButton url="https://docs.dymension.xyz/build/overview/" imageSrc="/build/dymension.webp" text="Dymension" alt="Dymension logo" aria-label="Dymension"/> | |
| <UrlImageButton url="https://rollkit.dev" imageSrc="/build/rollkit.webp" text="Rollkit" notes="Sovereign" alt="Rollkit logo" aria-label="Rollkit"/> | |
| </div> |
|
|
||
| ## What is a modular blockchain? | ||
|
|
||
| With blockchains there are more or less four core functions that they do. |
Contributor
There was a problem hiding this comment.
Consider adding a comma after "blockchains" for better readability:
- With blockchains there are more or less four core functions that they do.
+ With blockchains, there are more or less four core functions that they do.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.
Suggested change
| With blockchains there are more or less four core functions that they do. | |
| With blockchains, there are more or less four core functions that they do. |
| many more users. And modular blockchains use some new innovative | ||
| technologies that can help us get there. | ||
|
|
||
| - [Data availability sampling](https://celestia.org/glossary/data-availability-sampling/) |
Contributor
There was a problem hiding this comment.
There seems to be an unpaired symbol issue with the markdown link. Ensure that the markdown syntax is correct to avoid broken links:
- - [Data availability sampling](https://celestia.org/glossary/data-availability-sampling/)
+ - [Data availability sampling](https://celestia.org/glossary/data-availability-sampling)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.
Suggested change
| - [Data availability sampling](https://celestia.org/glossary/data-availability-sampling/) | |
| - [Data availability sampling](https://celestia.org/glossary/data-availability-sampling) |
| VM stack. | ||
|
|
||
| With existing rollup frameworks, developers can run rollup testnets | ||
| using the EVM or Cosmos SDK. In the future, one can imagine a variety |
Contributor
There was a problem hiding this comment.
The phrase "a variety of" may be considered wordy. Consider simplifying it for clarity and conciseness:
- In the future, one can imagine a variety of VMs that rollup frameworks support, providing developers...
+ In the future, one can imagine various VMs that rollup frameworks support, providing developers...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.
Suggested change
| using the EVM or Cosmos SDK. In the future, one can imagine a variety | |
| using the EVM or Cosmos SDK. In the future, one can imagine various VMs that rollup frameworks support, providing developers... |
jcstein
added a commit
that referenced
this pull request
Apr 16, 2024
* feat: drafting buttons * fix: color of btn * feat: add note text optional * feat: rename to build-whatever.md * fix: copy * feat: category shuffle * fix: suggestions from code review * feat: add vistara * Apply suggestions from code review * fix: typo * feat: add alt texts * fix: typo * feat: aria-labels * docs: shuffle intro
rach-id
added a commit
that referenced
this pull request
Apr 18, 2024
…stream (#1489) * docs: add documentation on how to build rollups on Celestia * docs: remove question * docs: one -> value * docs: explain more the proofs + reformating * docs: set ETA * docs: expand on protobuf deserialisation * docs: expand on protobuf deserialisation * docs: rewrite, reorganise, explain * docs: review feedback * docs: grammar * docs: remove new lines * docs: add links to inclusion proofs * docs: update blobstream contract addresses (#1485) Replaces #1482 * ci: test removing the CNAME file for clean up of previews. (#1493) * docs: update blobstream (#1495) * docs: update bubs-testnet.md with new URIs * docs: add status page and bridge * docs: comment out thirdweb bc chain is different now * docs: update gm portal and contract guides for bubs * docs: add mocha and namespace * docs: add bridging context * [GH Action] Update release tags and commit SHAs for arabica (#1497) * [automated GH action] update latest release tags & commit sha (arabica) * Update .vitepress/constants/arabica_versions.js --------- Co-authored-by: jcstein <jcstein@users.noreply.github.com> Co-authored-by: Josh Stein <46639943+jcstein@users.noreply.github.com> * [GH Action] Update release tags and commit SHAs for mocha (#1498) * [automated GH action] update latest release tags & commit sha (mocha) * Update .vitepress/constants/mocha_versions.js --------- Co-authored-by: jcstein <jcstein@users.noreply.github.com> Co-authored-by: Josh Stein <46639943+jcstein@users.noreply.github.com> * docs: update go constants for arabiac and mocha * docs: update to make install for all types of machines (#1502) * feat: Update node-tutorial.md (#1478) this is live in v0.13.0 i think, cc @vgonkivs for review * feat: split consensus node page (#1472) * docs: split consensus node page * docs: setup to set up * docs: setup to set up 2 * docs: coderabbit reviews * docs: change to everywhere * docs: add backlink --------- Co-authored-by: jcstein <mail@jcstein.dev> * docs: rollup available link Vitalik (#1505) * docs: rollup link Vitalik * docs: changes follow suggestion for example giving comma * docs: Fix proof query example errors (#1504) * Add missing return statement in toRowProofs function * fix dataRoot slice out of range error * fixes another missing return in toRowProofs * docs: fix blobstream proof queries code (#1506) * docs: initial commit, needs revision * docs: remove old light node config * docs: edits and refactor page * docs: minor copy edit * docs: cleanup for new deployment guide * docs: todos for deployment guide * docs: edit intro * docs: step 1-2 * docs: deploy steps and table * docs: remainder of deploy steps draft * docs: change style of quickstart to Quickstart: Deploy an Orbit rollup * docs: add todos * docs: update contract addresses * docs: using light node, namespace, auth token * docs: add link to arb doc * docs: add todo * docs: resolve build errs * docs: add bridging guide * docs: small revisions * docs: copy edits * docs: deploy revision * docs: fix blobstream address * docs: add alchemy rpc section * docs: note about opening ports in docker * docs: bump celestia-node version * docs: edit l1 to l2 * docs: add newer success logs * feat: add full node page to docs for orbit * feat: write out full node page * docs: more info on validatorfn page * docs: update wasm root * docs: update nitro release * docs: use v2.3.1-rc.1 everywhere for nitro * docs: edit out 'click heres' * fix: links * docs: add eth-rpc variable * docs: coderabbit suggestions * docs: clarify wss * docs: swap steps 6 and 7 for deploy doc * docs: edit wss section * docs: add more context for wss * docs: improve md readabliity in table * docs: update deployui url * docs: update ui url * docs: we'll use in next step * docs: updates * docs: add fn * [GH Action] Update release tags and commit SHAs for mainnet (#1507) * [automated GH action] update latest release tags & commit sha (mainnet) * Update .vitepress/constants/mainnet_versions.js --------- Co-authored-by: jcstein <jcstein@users.noreply.github.com> Co-authored-by: Josh Stein <46639943+jcstein@users.noreply.github.com> * docs: update newmetric endpoints Resolves #1501 * docs: update orbit URL * docs: coderabbit suggestions * docs: add op raspberry testnet * [GH Action] Update release tags and commit SHAs for arabica (#1511) * [automated GH action] update latest release tags & commit sha (arabica) * Apply suggestions from code review --------- Co-authored-by: jcstein <jcstein@users.noreply.github.com> Co-authored-by: Josh Stein <46639943+jcstein@users.noreply.github.com> * docs: add sepolia -> mocha (#1512) * fix typo in arabica-devnet page (#1513) * [WIP] docs: add audits for blobstream x (#1491) * docs: add audits for blobstream x * docs: add veridise audit * Update rollup-overview.md (#1516) * feat: restructure developers category (#1515) * feat: drafting buttons * fix: color of btn * feat: add note text optional * feat: rename to build-whatever.md * fix: copy * feat: category shuffle * fix: suggestions from code review * feat: add vistara * Apply suggestions from code review * fix: typo * feat: add alt texts * fix: typo * feat: aria-labels * docs: shuffle intro * feat: add celestia-node.sh script * fix: clarify section vs. tutorial * feat: exit if dir change fails * Update mocha_versions.js (#1529) * Update mocha_versions.js * Update mocha_versions.js * Add Grove archival endpoints to `nodes/mainnet.md` (#1525) * Add Grove to nodes/mainnet.md * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update nodes/mainnet.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Store image in src code * Add description of archival nodes * Apply suggestions from code review * Apply suggestions from code review * Update nodes/mainnet.md --------- Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * docs: fix typos (#1526) * fix typo * fix typo * fix typo * fix typo * fix typos * fix typo * fix typo * fix typos * fix typos * fix typos * fix typos * fix typo * fix typo * fix typo Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Apply suggestions from code review --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * Update mainnet.md (#1527) Add noders endpoints * Update mocha-testnet.md (#1528) * Update mocha-testnet.md Add noders endpoints * Fixed link to endpoint * Apply suggestions from code review --------- Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * fix: veridise path * feat: add to menu * docs: begin lint * docs: remove duplicate headings * docs: clarify duplicate headings * docs: better headings * docs: mention blobstream rollups docs in the blobstream overview --------- Co-authored-by: Josh Stein <46639943+jcstein@users.noreply.github.com> Co-authored-by: Matthew Sevey <mjsevey@gmail.com> Co-authored-by: jcstein <mail@jcstein.dev> Co-authored-by: celestia-bot <136652805+celestia-bot@users.noreply.github.com> Co-authored-by: jcstein <jcstein@users.noreply.github.com> Co-authored-by: Levai Mackenzie Ágbàrà <levaiagbara@gmail.com> Co-authored-by: Guspan Tanadi <36249910+guspan-tanadi@users.noreply.github.com> Co-authored-by: Kassius <34594014+CryptoKass@users.noreply.github.com> Co-authored-by: Ratan Kaliani <ratankaliani@berkeley.edu> Co-authored-by: Callum Waters <cmwaters19@gmail.com> Co-authored-by: Alex Beckett <75361908+alex-beckett@users.noreply.github.com> Co-authored-by: mindstyle85 <55639830+mindstyle85@users.noreply.github.com> Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: omahs <73983677+omahs@users.noreply.github.com> Co-authored-by: Alex Moskaleu (SeptimA) <dudava45@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
WIP
Resolves #1514
Resolves #1494
Menu
Buttons
Summary by CodeRabbit
New Features
Documentation
Bug Fixes