Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| - name: Export static HTML | ||
| run: yarn next export | ||
|
|
||
| - name: Deploy preview |
Check failure
Code scanning / CodeQL
Checkout of untrusted code in a privileged context Critical
Summary of ChangesHello @lukecd, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request represents a significant architectural shift for the documentation site, migrating the entire platform from VitePress to a Next.js/Nextra framework. This change involves a complete restructuring of the content, introducing new top-level sections like 'Learn,' 'Build,' and 'Operate,' and laying the groundwork for a more dynamic and modular documentation experience. The existing documentation content has been largely replaced with new files reflecting this new structure, including an overview for IBC and a Go client tutorial. Highlights
Ignored Files
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request marks a significant migration of the documentation site from VitePress to Next.js with Nextra, alongside a restructuring of the content. While this is a major step forward, my review has identified several critical and high-severity issues that need attention. These include a misconfigured 'Edit this page' link, broken image references, incorrect component syntax that will lead to rendering errors, and the removal of important contributor information from the README. I've also noted some medium-severity concerns regarding dark mode support for the logo and the use of beta dependencies, which could affect stability. Addressing these points will be crucial for ensuring the new documentation site is fully functional, maintainable, and user-friendly.
| [](https://discord.com/invite/celestiacommunity) | ||
| [](https://www.apache.org/licenses/LICENSE-2.0) | ||
| [](https://deepwiki.com/celestiaorg/docs) | ||
| This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). |
There was a problem hiding this comment.
The new README.md is the default from create-next-app. The old README contained valuable information for contributors, including contribution guidelines and documentation standards. This information should be preserved, either by updating the new README or by moving the content to a CONTRIBUTING.md file. Removing it entirely makes it harder for new contributors to get started.
| :::tip | ||
| For QuickNode: `CELE_DA_URL` uses `https://` and no port, while `CELE_CORE_GRPC` uses a port (e.g. `:9090`) and no `https://` prefix. | ||
| ::: |
There was a problem hiding this comment.
The ::::tip syntax is from VitePress and is not supported in Nextra. This will cause a rendering error. Please use the <Callout> component instead, and ensure it's imported at the top of the file with import { Callout } from 'nextra/components'.
<Callout type="info">
For QuickNode: `CELE_DA_URL` uses `https://` and no port, while `CELE_CORE_GRPC` uses a port (e.g. `:9090`) and no `https://` prefix.
</Callout>
| banner={banner} | ||
| navbar={navbar} | ||
| pageMap={await getPageMap()} | ||
| docsRepositoryBase="https://github.com/shuding/nextra/tree/main/docs" |
There was a problem hiding this comment.
The docsRepositoryBase is pointing to a Nextra example repository. This will cause the "Edit this page" link to point to the wrong location. It should be updated to point to this project's repository.
| docsRepositoryBase="https://github.com/shuding/nextra/tree/main/docs" | |
| docsRepositoryBase="https://github.com/celestiaorg/docs/tree/main" |
|
|
||
| ## How bridging works | ||
|
|
||
|  |
There was a problem hiding this comment.
This image path points to /img/ibc-diagram.png, but the image file does not appear to be included in the pull request. This will result in a broken image. Please ensure the image is added to the public/img/ directory.
| <Image | ||
| src="/logo-light.svg" | ||
| alt="Celestia" | ||
| width={140} | ||
| height={32} | ||
| priority | ||
| style={{ height: 'auto' }} | ||
| /> |
There was a problem hiding this comment.
The logo is hardcoded to the light version (logo-light.svg), which will not have good visibility in dark mode. The previous VitePress configuration supported separate light and dark mode logos. A similar mechanism should be implemented here. You could use a component that renders different SVGs based on the theme, or use CSS to switch between two images.
| You can use IBC to bridge assets between Celestia-native chains along with other chains. | ||
|
|
||
| <Callout type="info"> | ||
| Celestia uses relayers to forward packets between chains. Relayers are processes that can be run by anyone which constantly scan for outbound packets on one chain and submits these packets alongside corresponding proofs on the destination chain. This doc covers using IBC to bridge assets, we also [have docs on how to run a relayer](TODO). |
There was a problem hiding this comment.
This link is a placeholder (TODO). Please update it to point to the correct documentation for running a relayer.
|
|
||
|  | ||
|
|
||
| **TEMPOARY DIAGRAM, WELL HAVE YONI REDO IN CELESTIA STYLE IN THE FUTURE** |
There was a problem hiding this comment.
There are a couple of typos in this placeholder note. TEMPOARY should be TEMPORARY, and WELL should be WE'LL.
**TEMPORARY DIAGRAM, WE'LL HAVE YONI REDO IN CELESTIA STYLE IN THE FUTURE**
| <div style={{textAlign: 'center', fontFamily: "'Comic Sans MS', cursive", background: 'linear-gradient(45deg, #ff00ff, #00ffff, #ffff00)', padding: '20px', border: '5px dashed #ff0000', margin: '20px'}}> | ||
|
|
||
| <img src="/underConstruction.png" alt="Under Construction Mammoth" style={{maxWidth: '100%', height: 'auto', margin: '20px 0'}} /> | ||
|
|
||
| <h2 style={{color: '#ff0000', textShadow: '2px 2px 4px #000000', fontSize: '2em', margin: '20px 0'}}> | ||
| 🔥 CELESTIA DOCS ARE BEING BUILT 🔥 | ||
| </h2> | ||
|
|
||
| <p style={{fontSize: '1.2em', color: '#0000ff', background: '#ffff00', padding: '10px', border: '3px solid #ff0000', margin: '20px'}}> | ||
| <strong>⚠️ WARNING: This site is under heavy construction! ⚠️</strong><br/> | ||
| Our mammoth construction crew is working hard to bring you the best docs ever!<br/> | ||
| Please check back soon for the full experience! 🦣 | ||
| </p> | ||
|
|
||
|
|
||
| <div style={{background: '#ffff00', color: '#ff0000', padding: '10px', border: '3px solid #0000ff', margin: '20px', fontWeight: 'bold'}}> | ||
| 🎵 <span>COMING SOON TO A BROWSER NEAR YOU!</span> 🎵 | ||
| </div> | ||
|
|
||
| <div style={{textAlign: 'center', margin: '30px 0'}}> | ||
| <a href="/learn" style={{background: '#ff00ff', color: '#ffffff', padding: '10px 20px', textDecoration: 'none', border: '3px solid #000000', fontWeight: 'bold', margin: '10px', display: 'inline-block'}}>📚 LEARN</a> | ||
| <a href="/build" style={{background: '#00ffff', color: '#000000', padding: '10px 20px', textDecoration: 'none', border: '3px solid #000000', fontWeight: 'bold', margin: '10px', display: 'inline-block'}}>🛠️ BUILD</a> | ||
| <a href="/operate" style={{background: '#ffff00', color: '#000000', padding: '10px 20px', textDecoration: 'none', border: '3px solid #000000', fontWeight: 'bold', margin: '10px', display: 'inline-block'}}>⚙️ OPERATE</a> | ||
| </div> | ||
|
|
||
| <div style={{background: '#ff0000', color: '#ffffff', padding: '15px', border: '5px solid #ffff00', margin: '20px', textAlign: 'center'}}> | ||
| <h3 style={{margin: '0'}}>🦣 MAMMOTH CONSTRUCTION CREW 🦣</h3> | ||
| <p style={{margin: '10px 0 0 0', fontSize: '0.9em'}}>Building the future of modular blockchains, one pixel at a time!</p> | ||
| </div> | ||
|
|
||
| </div> No newline at end of file |
There was a problem hiding this comment.
This page uses a lot of inline styles, which can be difficult to maintain. For better separation of concerns and reusability, consider moving these styles to a dedicated CSS file and using classes instead.
| # Using Twinkle to post and retrieve blobs on Celestia | ||
|
|
||
| [Twinkle](https://t.tech/) is a hosted API service that lets you interact with Celestia's data availability layer without running your own node. With an API key, you can post and retrieve blobs on Celestia. | ||
| [Twinkle](https://t.tech/) is a hosted API service that lets you interact with Celestia's data availability layer without running your own node. With an API key, you can post and retrieve blobs on Celestia and pay for storage using a credit card. |
There was a problem hiding this comment.
i'm starting to see credit card as a huge benefit
| @@ -0,0 +1,5 @@ | |||
| export default { | |||
|
@lukecd, I just realized this has a google doc in it with markdown, which is hard to edit in the docs. is this in review elsewhere before being put into code? https://github.com/celestiaorg/docs/blob/docs-glow-up/app/learn/features/private-da/page.mdx |
3 participants
this PR