{"id":30113974,"url":"https://github.com/near/docs","last_synced_at":"2025-08-10T07:37:02.033Z","repository":{"id":37621134,"uuid":"163892008","full_name":"near/docs","owner":"near","description":"NEAR Protocol Documentation","archived":false,"fork":false,"pushed_at":"2025-08-05T02:17:28.000Z","size":226259,"stargazers_count":165,"open_issues_count":70,"forks_count":412,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-08-05T04:10:51.155Z","etag":null,"topics":["blockchain","community","documentation","nearprotocol","smart-contracts"],"latest_commit_sha":null,"homepage":"https://docs.near.org","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/near.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-01-02T21:35:06.000Z","updated_at":"2025-08-04T15:35:34.000Z","dependencies_parsed_at":"2025-08-05T04:17:57.121Z","dependency_job_id":null,"html_url":"https://github.com/near/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/near/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/near%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/near%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/near%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/near%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/near","download_url":"https://codeload.github.com/near/docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/near%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269693477,"owners_count":24460230,"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","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["blockchain","community","documentation","nearprotocol","smart-contracts"],"created_at":"2025-08-10T07:37:01.302Z","updated_at":"2025-08-10T07:37:02.018Z","avatar_url":"https://github.com/near.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cbr /\u003e\n\u003cbr /\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/near/node-docs/raw/refs/heads/main/website/static/img/near_logo.svg\" width=\"240\"\u003e\n\u003c/p\u003e\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n## NEAR Protocol - scalable and usable blockchain\n\n[![Discord](https://img.shields.io/discord/490367152054992913.svg)](http://near.chat)\n[![CI](https://github.com/near/docs/actions/workflows/build-check.yml/badge.svg)](https://github.com/near/docs/actions/workflows/build-check.yml)\n\nThis 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.\n\n## Quick start\n\nCheck out the following links:\n\n- Deployed, live documentation: https://docs.near.org\n- Example applications: https://github.com/near-examples\n- Community chat: https://near.chat\n\n## Contributing\n\nNEAR uses [Docusaurus](https://docusaurus.io) for documentation. Please refer to their documentation for details on major structural contributions to the documentation.\n\nFor simple content changes you have 2 options:\n\n- [Submit an issue](https://github.com/near/docs/issues)\n- [Submit a pull request](https://github.com/near/docs/pulls) *(we prefer PRs of course)*\n\n### The instant PR\n\nThis is the fastest way to submit content changes directly from the page where you notice a mistake.\n\n1. Open any page in the docs on https://docs.near.org\n2. Click the `[ Edit ]` button at the top right hand side of _every_ content page\n3. Make your edits to the document that opens in GitHub by clicking the ✎ (pencil) icon\n4. Submit a PR with your changes and comments for context\n\n### The typical PR\n\nThis is the standard fork-branch-commit workflow for submitting pull requests to open-source repositories:\n\n1. Fork this repo to your own GitHub account (or just clone it directly if you are currently a member of NEAR)\n\n2. Open your editor to the _top level repo folder_ to view the directory structure as seen below\n\n3. Move into the `/website` folder where you will run the following commands:\n\n   - Make sure all the dependencies for the website are installed:\n\n     ```sh\n     # Install dependencies\n     yarn\n     ```\n\n   - Run the local docs development server\n\n      ```sh\n      # Start the site\n      yarn start\n      ```\n\n      _Expected Output_\n\n      ```sh\n      # Website with live reload is started\n      LiveReload server started on port 35729\n      Docusaurus server started on port 3000\n      ```\n\n      The website for docs will open your browser locally to port `3000`\n\n4. Make changes to the docs\n\n5. Observe those changes reflected in the local docs\n\n6. Submit a pull request with your changes - **[Please check for broken links before opening PR 🙏](#check-for-broken-links)**\n\n## Directory Structure\n\nYour project file structure should look something like this with a few key files and folders highlighted\n\n```\n├── CODE_OF_CONDUCT.md\n├── CONTRIBUTING.md\n├── LICENSE-APACHE.txt\n├── LICENSE-MIT.txt\n├── README.md             \u003c-- the document you are reading right now\n├── docs                  \u003c-- all the content for the site is in this folder as markdown files\n└── website\n    ├── build\n    ├── core\n    ├── i18n\n    ├── package.json\n    ├── pages\n    ├── sidebars.js     \u003c-- rarely used for changing left-hand-side page navigation\n    ├── docusaurus.config.js     \u003c-- rarely used for general site configuration (including header links)\n    ├── static\n    └── test-links.sh     \u003c-- always used to test links before submitting changes\n```\n\n## Found a broken link?\n\nFor broken links internal to the docs, please submit an issue or PR request as per above.\n\nIf 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\n\n## Check for broken links\n\nBefore opening a pull request, please check for broken links by navigating to `./website` directory and run:\n\n```bash\nyarn full-test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnear%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnear%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnear%2Fdocs/lists"}