{"id":19485309,"url":"https://github.com/ava-labs/avalanche-docs","last_synced_at":"2025-03-17T16:07:01.283Z","repository":{"id":37076445,"uuid":"310064032","full_name":"ava-labs/avalanche-docs","owner":"ava-labs","description":"Avalanche Builders Hub","archived":false,"fork":false,"pushed_at":"2025-03-10T10:04:55.000Z","size":335583,"stargazers_count":172,"open_issues_count":56,"forks_count":416,"subscribers_count":31,"default_branch":"master","last_synced_at":"2025-03-10T11:22:52.512Z","etag":null,"topics":["avalanche","blockchain","docs","web3"],"latest_commit_sha":null,"homepage":"https://build.avax.network","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ava-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2020-11-04T16:55:48.000Z","updated_at":"2025-03-10T07:41:27.000Z","dependencies_parsed_at":"2023-10-30T18:39:41.757Z","dependency_job_id":"2e664dad-0011-4d66-9c92-87efb4117a6c","html_url":"https://github.com/ava-labs/avalanche-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ava-labs%2Favalanche-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ava-labs%2Favalanche-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ava-labs%2Favalanche-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ava-labs%2Favalanche-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ava-labs","download_url":"https://codeload.github.com/ava-labs/avalanche-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244066239,"owners_count":20392405,"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":["avalanche","blockchain","docs","web3"],"created_at":"2024-11-10T20:27:02.180Z","updated_at":"2025-03-17T16:06:56.273Z","avatar_url":"https://github.com/ava-labs.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Avalanche Developer Docs\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"public/logo.png?raw=true\"\u003e\n\u003c/div\u003e\n\n## Overview\n\nThis repository contains the contents for the Avalanche Developer Docs\ndeployed at [https://docs.avax.network](https://docs.avax.network).\n\n## Contributing\n\nContributing to the docs site is a great way to get involved with the Avalanche dev community!\nHere's how to get started:\n\n### Quick Fixes\n\nFor small typos or corrections, it is easy to contribute without the need to clone/fork the\nrepository. Simply:\n\n- Find the page you want to edit.\n- Click on the \"Edit on GitHub\" button in the right sidebar\n- Make the changes and Hit \"Commit changes ...\"\n- Edit the `commit message` to describe the change in 4 or less words, and include any extra details in the description\n- Hit \"Sign off and commit changes\" to raise a PR with your proposed changes\n\n### New Content or Extensive Changes\n\nTo propose new docs or large edits to our existing pages, follow the steps accordingly:\n\n- **Ava Labs Github Organization Members:** Clone the repo\n  `git clone https://github.com/ava-labs/avalanche-docs.git`\n- **External Contributors:** Fork the repo via GitHub's GUI\n- Checkout to a new branch `git checkout -b \u003cyour-name/branch-name\u003e`\n- Make changes on your branch\n- `git add .`\n- **`yarn dev` to ensure the build passes**\n- `git commit -m \"some commit message\"`\n- `git push`\n- Head to [GitHub](https://github.com/ava-labs/avalanche-docs) and open a new pull request\n\n### Structure and Syntax\n\n- Docs are located in the [docs](content/docs) directory.\n- Our style guide can be found [here](style-guide.md).\n- All image files should be included under [public images folder](public/images).\n\n### Pull Request (PR)\n\n- All PRs should be made against the `master` branch.\n- Following a successful build, Vercel will deploy your branch where you can verify your changes.\n- Once your PR is merged into `master`, [https://docs.avax.network/](https://docs.avax.network/) will be updated with your changes.\n\n### Installation\n\n```bash\nyarn install\n```\n\n### Local Development\n\n```bash\nyarn run start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are\nreflected live without having to restart the server.\n\n### Build\n\n```bash\nnext build\n```\n\nThis command generates static content into the `.next` directory and can be rendered using Next server.\n\n## New or Missing Content Requests\n\n_The information I am requesting is related to a specific project, i.e. AvalancheGo, AvalancheNetworkRunner, etc.:_\n\n- Please raise a **Missing Docs Issue** in the GitHub repository of that project and\n  thoroughly detail your request. Include references to any existing pages relevant to your\n  request.\n\n_The information I am requesting is explanatory in nature and does not currently exist:_\n\n- Please open a new [Issue](https://github.com/ava-labs/avalanche-docs/issues/new/choose)\n  in this repository and thoroughly detail your request according to the issue template.\n  If urgent, please create a new ticket in the\n  [Dev Docs Improvement Proposals](https://github.com/orgs/ava-labs/projects/15/views/1)\n  dashboard.\n\n_Erroneous or missing information on documentation unrelated to a specific project needs\nediting:_\n\n- If you understand the issue enough to provide a correction, follow the steps\n  [here](https://github.com/ava-labs/avalanche-docs#quick-fixes).\n- If not, please raise an [Issue](https://github.com/ava-labs/avalanche-docs/issues/new/choose).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fava-labs%2Favalanche-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fava-labs%2Favalanche-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fava-labs%2Favalanche-docs/lists"}