Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.84 KB

README.md

File metadata and controls

49 lines (34 loc) · 1.84 KB
Raw

Deploy

Celestia Documentation Site

Welcome to the official documentation repository for Celestia.

Here you'll find comprehensive guides, tutorials, and reference materials to help you make the most out of Celestia.

Building the site

To get started, clone the repository and run the following:

yarn && yarn dev

This documentation site is built with VitePress

Contribution Guidelines

We love contributions from the community! Whether you're fixing typos, improving content clarity, or adding new topics, every contribution helps.

  • Fork & clone: Fork this repository and clone it to your local machine.
  • Branch: Always create a new branch for your changes. Naming it relevantly.
  • Commit Changes: Make your changes and commit them with a clear and concise commit message.
  • Push & Create PR: Push your changes to your fork and create a pull request to the main branch of this repository.

Please ensure to review the detailed Contribution Guidelines above before making a pull request.

Directory Structure

  • /learn: A category for learning about Celestia.
  • /how-to guides: A category with guides for running a node, deploying rollups, and building on Celestia.
  • /tutorials: A category with tutorials on interacting with celestia-node.
  • /community: A category for the Celestia community.
  • /public: Images, diagrams, and other media files used in the documentation.

Feedback & Suggestions

We value feedback from the community. If you have suggestions for improvements or find any discrepancies in the documentation, please raise an issue in this repository.