Welcome to the NEAR Protocol! This blog will guide you through the essential steps of contributing to NEAR Protocol’s documentation. Built to be scalable and user-friendly, NEAR Protocol stands out as a powerful carbon-neutral blockchain. Let’s take a closer look at how you can make meaningful contributions and ensure seamless operation.

Understanding NEAR Protocol

NEAR Protocol is designed with performance, security, and infinite scalability in mind. If you’re eager to jump in, here’s a quick start guide!

Quick Start Links

• Deployed, live documentation
• Example applications
• Community chat

How to Contribute to NEAR Documentation

NEAR utilizes Docusaurus for its documentation framework. You can contribute either by making simple content changes or submitting more substantial edits through pull requests (PRs).

Instant PR: For Quick Edits

The instant PR allows for rapid submissions directly from any documentation page:

1. Open any page on NEAR Docs
2. Click the Edit button at the top right of the page
3. Make your edits on the document that opens in GitHub by clicking the pencil icon
4. Submit your PR with comments for context

Typical PR: Standard Approach

Alternatively, follow this structured process to make more significant contributions:

1. Fork the NEAR repository to your GitHub account or clone it if you’re a NEAR member.
2. Open the top-level repo folder in your editor.
3. Navigate to the website folder and run the following commands:

sh
# Install dependencies
yarn

4. Start the local docs development server:

sh
# Start the site
yarn start

5. Your local browser will launch at localhost:3000 displaying the NEAR docs.
6. Make desired changes to the docs.
7. Observe the changes in real-time within your local documentation site.
8. Submit a pull request, ensuring to check for broken links before doing so.

Understanding Directory Structure

To navigate the project efficiently, here’s how your project file structure should look:

CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE-APACHE.txt
LICENSE-MIT.txt
README.md
docs                  -- all content for the site
  website
  build
  core
  i18n
  package.json
  pages
  sidebars.js       -- side navigation
  docusaurus.config.js -- general site configuration
  static
  test-links.sh      -- for testing links

Troubleshooting Steps

If you encounter issues, such as broken links, you can resolve them by either submitting an issue or a PR. For broken external links sourced from Google, request their removal from the index here.

Before submitting a PR, ensure all links are functioning. You can check for broken links using:

bash
yarn test

Or, if you are in the .website directory:

bash
yarn full-test

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.