https://github.com/celestiaorg/docs

Celestia Documentation Site
https://github.com/celestiaorg/docs

Last synced: 3 months ago
JSON representation

Celestia Documentation Site

• Host: GitHub
• URL: https://github.com/celestiaorg/docs
• Owner: celestiaorg
• Created: 2022-03-16T19:38:30.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T14:28:44.000Z (8 months ago)
• Last Synced: 2024-04-01T16:09:21.042Z (8 months ago)
• Language: TypeScript
• Homepage: https://docs.celestia.org
• Size: 156 MB
• Stars: 150
• Watchers: 25
• Forks: 308
• Open Issues: 49
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-ccamel - celestiaorg/docs - Celestia Documentation Site (TypeScript)

README

        
# 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:

```bash

yarn && yarn dev

```

This documentation site is built with [VitePress](https://vitepress.dev)

## 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.

- /developers: A category with tutorials and guides for deploying

  rollups and interacting with Celestia nodes.

- /nodes: Technical reference materials for all node types.

- /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.