Welcome to the official documentation repository for Celestia.
- Live site: https://docs.celestia.org
Celestia Documentation Access:
- Clean markdown: Add .md to any URL (e.g., https://docs.celestia.org/learn/TIA/overview.md)
- LLMs.txt: https://docs.celestia.org/llms.txt
- Skill file: https://docs.celestia.org/SKILL.md
- CIPs: https://cips.celestia.org
- DeepWikis: https://deepwiki.com/celestiaorg/docs, https://deepwiki.com/celestiaorg/cips, https://deepwiki.com/celestiaorg/celestia-app, https://deepwiki.com/celestiaorg/celestia-node
- LLMs.txt: https://docs.celestia.org/llms.txt
- Skill file: https://docs.celestia.org/SKILL.md (served from
public/SKILL.md) - CIPs (Celestia Improvement Proposals): https://cips.celestia.org
- Built with: Next.js + Nextra (MDX), exported as a static site.
- LLM-ready: Add
.mdto any URL to get clean markdown (e.g.,https://docs.celestia.org/learn/TIA/overview→https://docs.celestia.org/learn/TIA/overview.md) - DeepWikis for @celestiaorg:
Prereqs: Node.js 20+ and Yarn.
yarn install
yarn devnext.config.mjs is configured for static export (output: 'export'). Builds write to out/ and generate a Pagefind search index in out/_pagefind/.
yarn build
yarn startFor deployments that live under a subdirectory (e.g. GitHub Pages previews), set:
BASEwith a trailing slash (used forassetPrefix)NEXT_PUBLIC_BASE_PATHwithout a trailing slash (used by client-side components for asset URLs)
BASE=/docs-preview/new_docs/ NEXT_PUBLIC_BASE_PATH=/docs-preview/new_docs yarn buildapp/**/page.mdx: documentation pagesapp/**/_meta.js: sidebar order/titlespublic/: static assets, including the published agent skill atpublic/SKILL.mdconstants/*.json: shared values referenced in MDX (e.g.{{mainnetVersions['app-latest-tag']}}), replaced byplugins/remark-replace-variables.mjs
yarn lint: lint the codebase (also runs ongit pushvia hook)yarn check-links -- --all: validate internal + external links (seescripts/check-links.mjs --help)yarn generate:llms: generate LLM-ready markdown files from MDX sources- Creates clean
.mdversions of all documentation pages - Removes JSX components, imports, and MDX-specific syntax
- Automatically runs during build process (
yarn build) - Access any doc page as markdown by adding
.mdto the URL
- Creates clean
Add the release asset to public/specs/, update constants/node_api_versions.json,
and run yarn generate:skill. The manifest drives the API dropdown, Fibre reference links,
LLM index, API catalog, and the version links in public/SKILL.md.
Keep bundled spec versions separate from automated network version updates.
CI runs yarn check:skill to reject stale skill links, missing or invalid specs,
and RPC methods in the skill that are absent from either current spec. It checks
availability, not behavioural compatibility or network activation; review method
guidance and release requirements when updating specs. Edit the skill's prose
outside the generated markers; its existing symlink remains the shared source.
We love contributions from the community! Whether you're fixing typos, improving clarity, or adding new topics, every contribution helps.
- Fork & clone: fork this repository and clone it locally
- Branch: create a new branch for your changes
- Commit: use clear, concise commit messages
- PR: push to your fork and open a pull request
Please review the full contribution guidelines before opening a PR: https://github.com/celestiaorg/.github/blob/main/CONTRIBUTING.md#external-contributions
This section outlines the standards and guidelines for maintaining consistent, high-quality documentation across the Celestia project.
- Sentence case: use sentence case for headings and titles (reference: #161)
- No “click here”: avoid using “click here” for link text (reference: #1073)
- International English: use international (common) English spelling and terminology
- Node types: use lowercase for node types (e.g., “bridge node”, not “Bridge Node”)
- Politeness: avoid using “please” in instructional content
- Unique headings: ensure no duplicate headings within a document
- Network references: use "Mainnet Beta" network (note the specific capitalization)
- Latin abbreviations: use italicized i.e. or e.g. instead of plain i.e. or e.g.
- Code references: use “celestia-app” in regular text (not inline code) when referring to the application name
- Tab ordering: when using network tabs, order them as: Mainnet Beta, Mocha
- Placeholders: use angle brackets with underscores for placeholders:
<flag_name>not<flag-name>or<flag name>
When updating documentation:
- Run automation: execute any available automation tools before manual updates
- Chain ID updates: if there are chain-id breaking changes:
- Update all chain-id references throughout the documentation
- Search comprehensively to ensure no references are missed
- Reference example: https://github.com/celestiaorg/docs/pull/857/files#diff-7c3322aa40bebbde7be394c354f900d6b5606eabbd03ac0d661f7565fcadcb70
- Release notes review: read release notes to identify and implement breaking changes that affect documentation
- Process reference: documentation update process video: https://www.loom.com/share/0d6897939b654b60b766887b37f86790
All software documentation must include:
- Proof of functionality (passing CI checks, manual testing evidence, block explorer links where applicable)
- Comprehensive setup (complete setup and usage instructions)
- Troubleshooting (common issues and solutions)
- Version compatibility (clearly state supported versions)
When adding internal links to documentation, use root-relative links with an optional section anchor:
[link text](/path/to/page/#section-id)
app/learn: learn about Celestiaapp/build: build on Celestia (including API/RPC references)app/operate: run and maintain nodes and infrastructure
GitHub Actions workflows in .github/workflows/ build the site and publish out/ for production and preview deployments.
If you find any discrepancies or have suggestions, please open an issue in this repository.