- ⚖️ NEAR Protocol is a new smart-contract platform that delivers scalability and usability.
- 🛠 Through sharding, it will linearly scale with the number of validation nodes on the network.
- 🗝 Leveraging WebAssembly (via Rust and AssemblyScript), more sane contract management, ephemeral accounts and many other advancements, NEAR finally makes using a blockchain protocol easy for both developers and consumers.
Check out the following links
- Deployed, live node documentation: https://near-nodes.io
- Example applications: https://near.dev
- Community chat: https://near.chat
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)
This is the fastest way to submit content changes directly from the page where you notice a mistake.
- Open any page in the docs on https://near-nodes.io
- Click the
[ Edit ]button at the top right hand side of every content page - Make your edits to the document that opens in GitHub by clicking the ✎ (pencil) icon
- Submit a PR with your changes and comments for context
This is the standard fork-branch-commit workflow for submitting pull requests to open source repositories
Fork this repo to your own GitHub account (or just clone it directly if you are currently a member of NEAR)
Open your editor to the top level repo folder to view the directory structure as seen below
Move into the
/websitefolder where you will run the following commands:Make sure all the dependencies for the website are installed:
# Install dependencies yarnRun the local docs development server
# Start the site yarn startExpected Output
# Website with live reload is started Docusaurus server started on port 3000The website for docs will open your browser locally to port
3000
Make changes to the docs
Observe those changes reflected in the local docs
Submit a pull request with your changes