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

Contributing

NEAR uses Docusaurus for documentation. Please refer to their documentation for details on major structural contributions to the documentation.

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. Move into the /website folder where you will run the following commands:

   • Make sure all the dependencies for the website are installed:

     # Install dependencies
     yarn

   • Run the local docs development server

     # Start the site
     yarn start

     Expected Output

     # Website with live reload is started
     LiveReload server started on port 35729
     Docusaurus server started on port 3000

     The website for docs will open your browser locally to port 3000

4. Make changes to the docs

5. Observe those changes reflected in the local docs

6. Submit a pull request with your changes - Please check for broken links before opening PR 🙏

Directory Structure

Your project file structure should look something like this with a few key files and folders highlighted

├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE-APACHE.txt
├── LICENSE-MIT.txt
├── README.md             <-- the document you are reading right now
├── docs                  <-- all the content for the site is in this folder as markdown files
└── website
    ├── build
    ├── core
    ├── i18n
    ├── package.json
    ├── pages
    ├── sidebars.js     <-- rarely used for changing left-hand-side page navigation
    ├── docusaurus.config.js     <-- rarely used for general site configuration (including header links)
    ├── static
    └── test-links.sh     <-- always used to test links before submitting changes

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

Check for broken links

Before opening a pull request, please check for broken links:

yarn test

or if you are in the ./website directory:

yarn full-test