docs: update readme WIP

[jcstein]

Overview

[gemini-code-assist]

Summary of Changes

Hello @jcstein, I'm Gemini Code Assist¹! 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 significantly updates the project's README.md file, transforming it from a standard Next.js boilerplate into a detailed and project-specific guide for the Celestia documentation. The changes aim to provide clear instructions for setting up a local development environment, understanding the project's architecture, and deploying the documentation, thereby streamlining the onboarding process for new contributors and providing essential context for existing team members.

Highlights

• README Overhaul: The README.md file has been completely rewritten, replacing the generic Next.js boilerplate with content tailored specifically for the Celestia documentation project.
• Celestia Documentation Focus: The updated README now clearly identifies the repository as the official documentation for Celestia, detailing its technology stack (Next.js + Nextra) and key resources like the live site and LLMs.txt.
• Enhanced Development and Deployment Instructions: New sections provide comprehensive guidance on local development prerequisites and commands, building and previewing static exports, configuring base paths for subpath deployments, and an overview of the content structure and useful development scripts.

Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request replaces the default Next.js README with a custom one tailored for the Celestia documentation project. The new README is a significant improvement, providing clear instructions for local development, building, and understanding the project structure.

I've added a couple of review comments:

• A medium-severity suggestion to improve developer experience by making a URL clickable.
• A high-severity comment pointing out a potential inconsistency between the link checking script and the build process regarding variable substitution, which could lead to broken links in production.

Additionally, please consider filling out the pull request description to provide more context for reviewers, and removing "WIP" from the title when it's ready for a final review.

[github-actions]

🚀 Preview Deployment

Your preview is ready: https://celestiaorg.github.io/docs-preview/pr-2356/