{"id":24296585,"url":"https://github.com/minaprotocol/docs2","last_synced_at":"2025-05-16T13:04:19.469Z","repository":{"id":42455555,"uuid":"404887636","full_name":"MinaProtocol/docs2","owner":"MinaProtocol","description":"Docs website for the Mina Protocol.","archived":false,"fork":false,"pushed_at":"2025-04-15T03:24:23.000Z","size":44889,"stargazers_count":96,"open_issues_count":175,"forks_count":153,"subscribers_count":21,"default_branch":"main","last_synced_at":"2025-05-15T10:21:44.555Z","etag":null,"topics":["blockchain","cryptocurrency","mina","zero-knowledge","zk","zkapps","zkp"],"latest_commit_sha":null,"homepage":"https://docs.minaprotocol.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MinaProtocol.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-09-09T22:33:39.000Z","updated_at":"2025-05-15T09:39:35.000Z","dependencies_parsed_at":"2023-09-28T21:44:27.753Z","dependency_job_id":"6b25ce74-d40b-4bc7-a88a-4e3295215f2c","html_url":"https://github.com/MinaProtocol/docs2","commit_stats":null,"previous_names":["minaprotocol/docs2"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MinaProtocol%2Fdocs2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MinaProtocol%2Fdocs2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MinaProtocol%2Fdocs2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MinaProtocol%2Fdocs2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MinaProtocol","download_url":"https://codeload.github.com/MinaProtocol/docs2/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254535826,"owners_count":22087398,"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","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","cryptocurrency","mina","zero-knowledge","zk","zkapps","zkp"],"created_at":"2025-01-16T19:08:28.832Z","updated_at":"2025-05-16T13:04:19.419Z","avatar_url":"https://github.com/MinaProtocol.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://github.com/MinaProtocol/docs/blob/main/public/static/img/svg/mina-wordmark-redviolet.svg\" width=\"350\" alt=\"Mina logo\"\u003e\n\n# Mina Docs\n\nThe Mina Docs website is [docs.minaprotocol.com](https://docs.minaprotocol.com/).\n\n## To contribute content\n\nThank you for your interest in contributing to the docs. To get started, see the docs [CONTRIBUTING](CONTRIBUTING.md) guidelines.\n\nThe docs output is generated by a CI pipeline so we can update the docs site whenever we want. The [Mina Docs](https://docs.minaprotocol.com/) website always contains the most up-to-date content available.\n\n## How to see your doc updates on PRs\n\nDuring the documentation build process, each PR goes through Vercel CI to test the doc updates and build a preview of your changes. Vercel for GitHub automatically deploys and provides preview deployment URLs. After the PR status is ready, click **Visit Preview** and navigate to the changed page to see your doc updates. If your Vercel preview fails, you might have errors. See [Debugging build errors](#debugging-build-errors).\n\n## How to see your local doc updates during development\n\nTo test the doc build and see local updates before you push changes to GitHub, be sure to build the docs locally.\n\n\u003c!-- In case of version change, update .github/workflows/{test-tutorials.yml, snarkjs-api-reference.md} accordingly --\u003e\n\nLocal builds require Node.js, version 18 or greater.\nOne way to install NPM is to rely on [nvm](https://github.com/nvm-sh/nvm). Use the following commands to install nvm and npm:\n\n```sh\ncurl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash\nnvm install v18\n```\n\nAfter your local build environment is set, you can run a local build:\n\n```sh\ngit clone https://github.com/o1-labs/docs2.git\nnpm install\nnpm run dev\n```\n\nThe `npm run dev` command does not run with broken link detection.\n\n## Debugging build errors\n\nTo build the site with broken link detection and to debug Vercel CI failures, you can gather more information on your local build:\n\n```sh\nnpm run build\n```\n\n## How to run in production\n\nOn the host:\n\n- Set environment variables: `ALGOLIA_APP_ID` and `ALGOLIA_SEARCH_API_KEY` to appropriate values\n- Set build command: `npm run build`\n- Set output directory: `build`\n- Set install command: `npm ci`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminaprotocol%2Fdocs2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminaprotocol%2Fdocs2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminaprotocol%2Fdocs2/lists"}