{"id":14786594,"url":"https://github.com/celestiaorg/docs","last_synced_at":"2025-10-20T05:14:41.956Z","repository":{"id":37264612,"uuid":"470727349","full_name":"celestiaorg/docs","owner":"celestiaorg","description":"Celestia Documentation Site","archived":false,"fork":false,"pushed_at":"2025-04-05T10:31:34.000Z","size":206374,"stargazers_count":179,"open_issues_count":33,"forks_count":404,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-04-07T02:12:02.054Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.celestia.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/celestiaorg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-16T19:38:30.000Z","updated_at":"2025-04-05T10:30:21.000Z","dependencies_parsed_at":"2023-10-23T15:31:48.454Z","dependency_job_id":"99be870c-7436-40d0-9106-3138955e103e","html_url":"https://github.com/celestiaorg/docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celestiaorg%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celestiaorg%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celestiaorg%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celestiaorg%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/celestiaorg","download_url":"https://codeload.github.com/celestiaorg/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248852131,"owners_count":21171840,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-17T07:01:41.789Z","updated_at":"2025-10-20T05:14:41.949Z","avatar_url":"https://github.com/celestiaorg.png","language":"TypeScript","funding_links":[],"categories":["MDX"],"sub_categories":[],"readme":"[![CodeQL](https://github.com/celestiaorg/docs/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/celestiaorg/docs/actions/workflows/github-code-scanning/codeql)\n[![Build](https://github.com/celestiaorg/docs/actions/workflows/build.yml/badge.svg)](https://github.com/celestiaorg/docs/actions/workflows/build.yml)\n[![Deploy](https://github.com/celestiaorg/docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/celestiaorg/docs/actions/workflows/deploy.yml)\n[![Twitter](https://img.shields.io/twitter/follow/celestia)](https://x.com/celestia)\n[![Discord](https://img.shields.io/discord/638338779505229824)](https://discord.com/invite/celestiacommunity)\n[![License](https://img.shields.io/badge/License-Apache2.0-green.svg)](https://www.apache.org/licenses/LICENSE-2.0)\n[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/celestiaorg/docs)\n\n# Celestia Documentation Site\n\nWelcome to the official documentation repository for [Celestia](https://celestia.org/).\n\nHere you'll find comprehensive guides, tutorials, and reference materials\nto help you make the most out of Celestia.\n\n## Building the site\n\nTo get started, clone the repository and run the following:\n\n```bash\nyarn \u0026\u0026 yarn dev\n```\n\nThis documentation site is built with [VitePress](https://vitepress.dev)\n\n## Link checking\n\nTo check for broken links in the documentation, run:\n\n```bash\nyarn link-check\n```\n\nThis uses [lychee](https://github.com/lycheeverse/lychee) to validate all internal and\nexternal links.\nThe link checker is also run automatically in CI on every push and pull request.\n\n## Contribution guidelines\n\nWe love contributions from the community! Whether you're fixing typos,\nimproving content clarity, or adding new topics, every contribution helps.\n\n- Fork \u0026 clone: Fork this repository and clone it to your local machine.\n- Branch: Always create a new branch for your changes. Naming it relevantly.\n- Commit Changes: Make your changes and commit them with a clear and concise\n  commit message.\n- Push \u0026 Create PR: Push your changes to your fork and create a pull request\n  to the main branch of this repository.\n\nPlease ensure to review the **[full Contribution Guidelines](https://github.com/celestiaorg/.github/blob/main/CONTRIBUTING.md#external-contributions)** before\nmaking a pull request.\n\n## Documentation standards\n\nThis section outlines the standards and guidelines for maintaining\nconsistent, high-quality documentation across the Celestia project.\n\n### Styling rules\n\n- **Sentence case**: Use sentence case for headings and titles\n  (reference: [issue #161](https://github.com/celestiaorg/docs/issues/161))\n- **No \"click here\"**: Avoid using \"click here\" for link text\n  (reference: [issue #1073](https://github.com/celestiaorg/docs/issues/1073))\n- **International English**: Use international (common) English spelling\n  and terminology\n- **Network names**: Use \"Arabica devnet\", not \"Arabica Devnet\"\n- **Node types**: Use lowercase for node types (_e.g._, \"bridge node\",\n  not \"Bridge Node\")\n- **Politeness**: Avoid using \"please\" in instructional content\n- **Unique headings**: Ensure no duplicate headings within a document\n- **Network references**: Use \"Coffee Beta\" network (note the specific\n  capitalization)\n- **Latin abbreviations**: Use italicized _i.e._ or _e.g._ instead of\n  plain i.e. or e.g.\n- **Code references**: Use `celestia-app` in regular text, not as inline\n  code when referring to the application name\n- **Tab ordering**: When using tabs, order them as: Coffee Beta, Mocha,\n  Arabica\n- **Placeholders**: Use angle brackets with underscores for placeholders:\n  `\u003cflag_name\u003e` not `\u003cflag-name\u003e` or `\u003cflag name\u003e`\n\n### Documentation update procedures\n\nWhen updating documentation:\n\n1. **Run automation**: Execute any available automation tools before\n   manual updates\n2. **Chain ID updates**: If there are chain-id breaking changes:\n   - Update all chain-id references throughout the documentation\n   - Search comprehensively to ensure no references are missed\n   - Reference example: [chain-id update PR](https://github.com/celestiaorg/docs/pull/857/files#diff-7c3322aa40bebbde7be394c354f900d6b5606eabbd03ac0d661f7565fcadcb70)\n3. **Release notes review**: Read through release notes to identify and\n   implement any breaking changes that affect documentation\n4. **Process reference**: See [documentation update process video](https://www.loom.com/share/0d6897939b654b60b766887b37f86790)\n\n### Documentation requirements for software\n\nAll software documentation must include:\n\n- **Proof of functionality**: Demonstrate that the software works through:\n  - Passing CI checks\n  - Manual testing evidence\n  - Links to block explorer (where applicable)\n  - Clear, step-by-step instructions for running the software\n- **Comprehensive setup**: Provide complete setup and usage instructions\n- **Troubleshooting**: Include common issues and their solutions\n- **Version compatibility**: Clearly state which versions are supported\n\n### Link format guidelines\n\nWhen adding internal links to documentation, please use the following format:\n`[link text](/base-working-dir/subdir/page.md#section-id)`, i.e. `[link text](/how-to-guides/quick-start.md#get-your-auth-token)`\n\nThis format ensures long-term compatibility and consistent behavior across\ndifferent platforms and documentation builds.\n\n## Directory structure\n\n- /learn: A category for learning about Celestia.\n- /how-to guides: A category with guides for running a node, deploying\n  rollups, and building on Celestia.\n- /tutorials: A category with tutorials on interacting with celestia-node.\n\u003c!-- * /guides [WIP]: In-depth articles that cover specific topics in detail. --\u003e\n- /community: A category for the Celestia community.\n- /public: Images, diagrams, and other media files used in the documentation.\n\n## Feedback \u0026 suggestions\n\nWe value feedback from the community. If you have suggestions for improvements\nor find any discrepancies in the documentation, please raise an issue in this\nrepository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcelestiaorg%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcelestiaorg%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcelestiaorg%2Fdocs/lists"}