NEAR Protocol - scalable and usable blockchain

This is the repository for the official documentation of NEAR Protocol, a user-friendly and carbon-neutral blockchain, built from the ground up to be performant, secure, and infinitely scalable.

Quick start

Check out the following links:

• Deployed, live documentation: https://docs.near.org
• Example applications: https://github.com/near-examples
• Community chat: https://near.chat

Local development

This documentation site is built with Mintlify.

Prerequisites

• Node.js 20.17.0 or newer
• The Mintlify CLI

npm i -g mint

Run the docs locally

From the repository root, start the local preview server:

mint dev

The site will be available at http://localhost:3000.

Contributing

NEAR uses Mintlify for documentation. Content is written in MDX and configured through docs.json at the repository root.

For simple content changes you have 2 options:

• Submit an issue
• Submit a pull request(we prefer PRs of course)

The instant PR

This is the fastest way to submit content changes directly from the page where you notice a mistake.

1. Open any page in the docs on https://docs.near.org
2. Click the [ Edit ] button at the top right hand side of every content page
3. Make your edits to the document that opens in GitHub by clicking the ✎ (pencil) icon
4. Submit a PR with your changes and comments for context

The typical PR

This is the standard fork-branch-commit workflow for submitting pull requests to open-source repositories:

1. Fork this repo to your own GitHub account (or just clone it directly if you are currently a member of NEAR)

2. Open your editor to the top level repo folder to view the directory structure as seen below

3. Install the Mintlify CLI if you do not already have it:

npm i -g mint

4. From the repository root, run the local docs development server:

mint dev

Expected result

The Mintlify preview starts locally and serves the docs at http://localhost:3000.

5. Make changes to the docs

6. Observe those changes reflected in the local preview

7. Submit a pull request with your changes and comments for context

Directory structure

The repo is organized around Mintlify content and configuration:

├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE-APACHE.txt
├── LICENSE-MIT.txt
├── README.md
├── docs.json <-- Mintlify site configuration and navigation
├── index.mdx <-- homepage
├── openapi.json <-- API reference source for Mintlify API docs
├── styles.css <-- custom site styling
├── api/ <-- API and RPC docs
├── assets/ <-- images and static assets
├── chain-abstraction/
├── data-infrastructure/
├── getting-started/
├── primitives/
├── protocol/
├── smart-contracts/
├── snippets/ <-- reusable MDX/JSX snippets and components
├── tools/
└── web3-apps/

Found a broken link?

For broken links internal to the docs, please submit an issue or PR request as per above.

If you found a broken link from a Google search, please request to remove it from their index here: https://www.google.com/webmasters/tools/removals

Validate changes locally

Before opening a pull request, start the local Mintlify preview from the repository root and verify the pages you changed load correctly without console errors:

mint dev
mint broken-links