{"id":13746367,"url":"https://github.com/w3f/polkadot-wiki","last_synced_at":"2026-06-19T15:33:51.135Z","repository":{"id":37246889,"uuid":"204518099","full_name":"w3f/polkadot-wiki","owner":"w3f","description":"The source of truth for Polkadot.","archived":false,"fork":false,"pushed_at":"2026-06-15T00:43:48.000Z","size":718066,"stargazers_count":430,"open_issues_count":38,"forks_count":2453,"subscribers_count":23,"default_branch":"master","last_synced_at":"2026-06-15T02:25:14.048Z","etag":null,"topics":["blockchain","documentation","education","kusama","polkadot","web3","wiki"],"latest_commit_sha":null,"homepage":"https://wiki.polkadot.com","language":"CSS","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/w3f.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-08-26T16:38:48.000Z","updated_at":"2026-06-03T06:49:28.000Z","dependencies_parsed_at":"2023-09-28T04:53:35.499Z","dependency_job_id":"62408354-e7d3-4852-b1ec-9acc6b0eaf9e","html_url":"https://github.com/w3f/polkadot-wiki","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/w3f/polkadot-wiki","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3f%2Fpolkadot-wiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3f%2Fpolkadot-wiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3f%2Fpolkadot-wiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3f%2Fpolkadot-wiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/w3f","download_url":"https://codeload.github.com/w3f/polkadot-wiki/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3f%2Fpolkadot-wiki/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34538220,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-19T02:00:06.005Z","response_time":61,"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","documentation","education","kusama","polkadot","web3","wiki"],"created_at":"2024-08-03T06:00:52.537Z","updated_at":"2026-06-19T15:33:51.128Z","avatar_url":"https://github.com/w3f.png","language":"CSS","funding_links":[],"categories":["CSS","Smart Contract Platforms"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg align=\"center\" src=\"./docs/assets/logo/polkadot_logo_dark.png\" width=\"200\"\u003e\n\u003c/p\u003e\n\n\u003cdiv align=\"Center\"\u003e\n\u003ch1\u003ePolkadot Wiki\u003c/h1\u003e\n\u003ch3\u003e The Source of Truth for Polkadot \u003c/h3\u003e\n\u003cbr\u003e\n  \n[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](#LICENSE)\n[![made-with-Markdown](https://img.shields.io/badge/Made%20with-Markdown-1f425f.svg)](https://www.markdownguide.org/)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](docs/general/contributing.md)\n\u003c/div\u003e\n\n\u003c!-- TOC --\u003e\n\n- [Contributing to Documentation](#contributing-to-documentation)\n- [Running Locally](#running-locally)\n  - [Build](#build)\n  - [Formatting](#formatting)\n  - [Vale - Writing Style Linter](#vale---writing-style-linter)\n    - [Installation](#installation)\n    - [Usage](#usage)\n    - [Configuration](#configuration)\n    - [Adding Custom Terms](#adding-custom-terms)\n  - [Automation](#automation)\n    - [Deployments](#deployments)\n    - [GitHub Actions](#github-actions)\n  - [Conditional Rendering](#conditional-rendering)\n  - [Mkdocs Macros](#mkdocs-macros)\n    - [RPC Macro Example](#rpc-macro-example)\n- [Internationalization](#internationalization)\n- [License](#license)\n\u003c!-- /TOC --\u003e\n\n---\n\n\u003cimg align=\"right\" src=\"https://user-images.githubusercontent.com/25497083/147788625-14e67f76-c53c-4992-8e84-d23cd78e88bd.png\" width=\"50\"\u003e\n\n\u003cp align=\"left\"\u003e\n  The Polkadot Wiki is the central source of truth for Polkadot. It is a community-focused initiative led by \n  Web3 Foundation to keep an up-to-date resource on the best information for learning, building, or maintaining \n  on Polkadot. \n\u003c/p\u003e\n\n## Contributing to Documentation\n\n[The Technical Education team](https://wiki.polkadot.com/general/contributors/) at Web3 Foundation\nare the primary maintainers of the Wiki and will review all issues and pull requests created on this\nrepository. If you notice typos or grammatical errors, please feel free to create pull requests with\nthese corrections directly. Larger contributions may start as issues to test the waters on the\nsubject with the maintainers. It is generally preferable to create a pull request over an issue to\npropose a change to the Wiki content.\n\nLearn more about [contributing](https://wiki.polkadot.com/general/contributing/).\n\n## Running Locally\n\n- Make sure `python` (Python 3.12+), `pip` and `mkdocs` are installed and configured in your path\n- It's recommended to use a virtual environment, as is common practice\n- Ensure you are in the `polkadot-wiki` directory\n\n1. Install dependencies \n    ```sh\n    pip install -r requirements.txt\n    ```\n\n2. Once installed, run the serve command:\n    ```sh\n    # Set ENABLE_RPC to true if you plan to work with RPC macros\n    ENABLE_RPC=false mkdocs serve\n    ```\n\n### Build\n\n🟣 Building the Polkadot Wiki:\n\n```bash\n# Set ENABLE_RPC to true if you plan to work with RPC macros\nENABLE_RPC=false mkdocs build\n```\n\n### Formatting\n\nSee the [Conditional Rendering](#conditional-rendering) and\n[Mkdocs Macros](#mkdocs-macros) sections for additional details regarding how to\nproperly format syntax for elements outside of the standard markdown library.\n\n### Vale - Writing Style Linter\n\nVale is configured to help maintain consistent writing style across the Wiki. It uses Google style guidelines along with Polkadot-specific terminology and rules.\n\n#### Installation\n\nInstall Vale via your package manager or download from [GitHub releases](https://github.com/errata-ai/vale/releases):\n\n```bash\n# macOS (using Homebrew)\nbrew install vale\n\n# Linux/Windows - Download from releases or use package manager\n```\n\n#### Usage\n\nRun Vale on specific files or directories:\n\n```bash\n# Check a single file\nvale docs/general/contributing.md\n\n# Check all markdown files in docs directory\nvale docs/\n\n# Check all files (respects .vale.ini configuration)\nvale .\n```\n\n#### Configuration\n\nThe Wiki's Vale configuration (`.vale.ini`) includes:\n- **Google Style Guide** rules for general writing quality\n- **Polkadot-specific vocabulary** and terminology\n- **Custom rules** for acronyms, contractions, and Polkadot ecosystem terms\n- **Industry vocabulary** for blockchain and technical terms\n\n#### Adding Custom Terms\n\nTo add new accepted terms to the vocabulary:\n1. Edit `.github/styles/config/vocabularies/Polkadot/accept.txt` for Polkadot-specific terms\n2. Edit `.github/styles/config/vocabularies/Industry/accept.txt` for general blockchain terms\n\n### Automation\n\n#### Deployments\n\nThe Polkadot Wiki is built in a CI job, where it is then deployed on Netlify. Each commit to master triggers a new build and production deployment.\n\nPull request previews are enabled, meaning a temporary deployment via Netlify is generated for each PR.\n\nAfter these jobs are successfully completed, the CICD production workflow will automatically deploy\n`prod` to the public site when the PR is merged to master: [Polkadot Wiki](https://wiki.polkadot.com).\n\n#### GitHub Actions\n\n| Job                                                                                                                       | Description                                                                                                                                                                                                       | Frequency                                                                                                       |\n| ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| [Audit Links](https://github.com/w3f/polkadot-wiki/blob/master/.github/workflows/audit-links.yml)                         | Test all links in the docs for broken references and opens a new issue displaying results if any are found.                                                                                                       | Monthly or [Workflow Dispatch](https://github.com/w3f/polkadot-wiki/actions/workflows/audit-links.yml)          |\n| [Code QL Analysis](https://github.com/w3f/polkadot-wiki/blob/master/.github/workflows/codeql.yml)                | Tests for vulnerabilities across the codebase                                                                                                                                                                     | Weekly, Push to `master` or Pull Request to `master`                                                            |\n| [Dependabot](https://github.com/w3f/polkadot-wiki/blob/master/.github/dependabot.yml)                                                                                                            | Helps keep packages up-to-date with latest release.                                                                                                                                                               | Daily                                                                                                           |\n| [Build and Deploy to Netlify](https://github.com/w3f/polkadot-wiki/blob/master/.github/workflows/preview.yml)         | Builds and deploys the site to Netlify. If it is a PR, it generates a preview. If it is a push to master, it will deploy on the production URL.                                                                            |\n| [Status Badges](https://github.com/w3f/polkadot-wiki/blob/master/.github/workflows/status-badges.yml)                     | Update the commit history of various [open source projects](https://github.com/w3f/polkadot-wiki/blob/master/docs/build/build-open-source.md) in the ecosystem.                                                   | Weekly or [Workflow Dispatch](https://github.com/w3f/polkadot-wiki/actions/workflows/status-badges.yml)         |\n\n### Conditional Rendering\n\nThe Polkadot Wiki does not support conditional rendering. If needed, represent multiple chains (i.e, Polkadot and Kusama) using the tab layout specified here on the[ Mkdocs Material documentation](https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#usage).\n\n### Mkdocs Macros\n\nMkdocs macros allow the use of Jinja2 templates and custom Python functions to allow for custom data fetching and rendering within Mkdocs. All current macros can be found in: [`macros/`](./macros/). \n\n#### RPC Macro Example\n\nFor example, the `rpc` macro can be used in the following manner, with each field representing the input for the function signature respectively.\n\n1. `rpc` macro function signature:\n\n```py\ndef rpc(network, module, call, default_value, is_constant=False, readable=\"\")\n```\n\n2. Example Usage:\n\n```md\n## Number of Nominators\n{{ rpc(\"polkadot\", \"Staking\", \"CounterForNominators\", 36793, is_constant=false) }}\n```\n\n3. Different types of readable, depending on usage and network: \n    * Percentage\n    * Human Readable / Human Readable Kusama (rounds to nearest 100)\n    * Blocks to days (converts blocks to days)\n    * Precise DOT / KSM (returns an unrounded number with full precision)\n\n| ---------------------------------------------------------------------------------------------------------------------------- |\n\n## License\n\nThe Polkadot Wiki is licensed under the [GPL-3.0](LICENSE) free software license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fw3f%2Fpolkadot-wiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fw3f%2Fpolkadot-wiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fw3f%2Fpolkadot-wiki/lists"}