diff --git a/.ai/pages/get-support-ai-ready-docs.md b/.ai/pages/get-support-ai-ready-docs.md index 8e27d211c..b14ecc7bb 100644 --- a/.ai/pages/get-support-ai-ready-docs.md +++ b/.ai/pages/get-support-ai-ready-docs.md @@ -17,7 +17,7 @@ Polkadot provides files to make documentation content available in a structure o These AI-ready files do not include any persona or system prompts. They are purely informational and can be used without conflicting with your existing agent or tool prompting. -## Download LLM Files +## Access LLM Files | Category | Description | File | Actions | |----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/.ai/pages/get-support-explore-resources.md b/.ai/pages/get-support-explore-resources.md deleted file mode 100644 index ca629b331..000000000 --- a/.ai/pages/get-support-explore-resources.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Subscribe to Updates -description: Find Polkadot developer resources, tutorials, forums, governance proposals, and community platforms like StackExchange, Reddit, and YouTube. -url: https://docs.polkadot.com/get-support/explore-resources/ ---- - -# Ask the Community and Explore Resources - -Looking for answers beyond the documentation? These platforms are full of useful content and experienced developers sharing insights. - -## 🧠 Stack Exchange - -- Browse commonly asked technical questions. -- Ask your own and get detailed responses from experienced devs. - -πŸ‘‰ **[Visit Polkadot Stack Exchange](https://substrate.stackexchange.com/){target=\_blank}** - -## 🧡 Reddit: r/Polkadot - -- General Polkadot discussions and community perspectives. -- Developer questions are welcome β€” just tag them appropriately. - -πŸ‘‰ **[Visit r/Polkadot](https://www.reddit.com/r/Polkadot/){target=\_blank}** - -## πŸ’¬ Discord (Community Threads Only) - -- Beyond the official support threads, most channels are community-driven. -- Great place to connect with fellow builders and share insights. - -πŸ‘‰ **[Join the Polkadot Discord](https://polkadot-discord.w3f.tools/){target=\_blank}** - -## πŸŽ₯ YouTube: @PolkadotNetwork - -- Developer tutorials -- Ecosystem interviews -- Event recordings and walkthroughs - -πŸ‘‰ **[Watch on YouTube](https://www.youtube.com/@PolkadotNetwork){target=\_blank}** - -## Community-Led Platforms and Ecosystem Updates - -Stay in sync with what's happening across the Polkadot ecosystem β€” from official announcements to community-driven insights and governance activity. - -### πŸ”· X (Twitter): Official Accounts - -- [@PolkadotDevs](https://x.com/PolkadotDevs){target=\_blank}: Updates for developers -- [@Polkadot](https://x.com/Polkadot){target=\_blank}: Network-wide news -- [@Kusamanetwork](https://x.com/kusamanetwork){target=\_blank}: Kusama-specific updates -- [@Web3Foundation](https://x.com/web3foundation){target=\_blank}: Grants, research, and ecosystem programs - -### πŸ” X (Twitter): Community Accounts - -- [@PolkadotDeploy](https://x.com/PolkadotDeploy){target=\_blank}: News from the deployment portal and tooling updates - -### πŸ—£οΈ Polkadot Forum - -- Join community discussions around the direction of the ecosystem. - -πŸ‘‰ **[Visit the Polkadot Forum](https://forum.polkadot.network/){target=\_blank}** - -### πŸ§‘β€βš–οΈ Polkassembly: OpenGov - -- Explore and vote on governance proposals for Polkadot and Kusama. -- Help shape the future of the network. - -πŸ‘‰ **[Explore on Polkassembly](https://polkadot.polkassembly.io/){target=\_blank}** - -### πŸ“Έ Instagram - -- **[@Polkadotnetwork](https://www.instagram.com/polkadotnetwork){target=\_blank}**: Visual highlights from the ecosystem - _(Note: not developer-specific)_ diff --git a/.ai/pages/get-support-get-in-touch.md b/.ai/pages/get-support-get-in-touch.md deleted file mode 100644 index 31629828a..000000000 --- a/.ai/pages/get-support-get-in-touch.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Get in Touch -description: Developer support for Polkadot via Telegram, Matrix, and Discord. Get help with parachains, smart contracts, nodes, and ecosystem tools. -url: https://docs.polkadot.com/get-support/get-in-touch/ ---- - -# Get in Touch Directly - -## Need Help Fast? - -Use one of the channels below to get live technical support or ask questions. - -
- - Connect to Telegram - - - Connect to Discord - -
- -Prefer to see all available channels? Below are your options. - -## πŸ“± Telegram: Polkadot Developer Support - -The fastest way to get support. - -- **Who’s there:** DevRel team and active developer community. -- **Response time:** Within **2 business days (usually faster)**. -- **Topics:** Any developer-related question is welcome. - -πŸ‘‰ **[Join Telegram](https://t.me/substratedevs){target=\_blank}** - -## πŸ”Œ Discord: Polkadot Official Server - -Focused support for smart contracts and general developer chat. - -- **Smart contracts:** Ask in `#solidity-smart-contracts` and `#ink_smart-contracts`. -- **General developer support:** Ask in `#solidity-smart-contracts`. -- **Response time:** Within **1 business day (usually faster)**. -- **Other topics:** Community-led discussion only. - -πŸ‘‰ **[Join Discord](https://polkadot-discord.w3f.tools/){target=\_blank}** - -## 🧬 Matrix: Polkadot Developer Support - -This is the **support channel** staffed by engineers from **Parity**, **Web3 Foundation**, and **Polkadot DevRel**. - -- **Who’s there:** Parity, W3F, DevRel, and community contributors. -- **Response time:** Within **1 business day (usually faster)**. -- **Topics:** Full-spectrum developer support. -- Bridged with Telegram (all messages synced). - -πŸ‘‰ **[Join Matrix](https://matrix.to/#/#substratedevs:matrix.org){target=\_blank}** - ---- - -Not sure where to start? - -**Join [Telegram](#telegram-polkadot-developer-support)**: Let us know what you need, and we’ll help you get unstuck. diff --git a/.ai/pages/get-support.md b/.ai/pages/get-support.md index 8505b9539..c07eb386e 100644 --- a/.ai/pages/get-support.md +++ b/.ai/pages/get-support.md @@ -4,42 +4,121 @@ description: Start here to get developer support for Polkadot. Connect with the url: https://docs.polkadot.com/get-support/ --- -# Need Help Fast? +# Polkadot Developer Support + +You're already in the docs β€” solid start. But sometimes you need more: answers, real examples, someone to talk to. This support hub is here to help you move forward β€” faster. + +If something’s missing, unclear, or broken β€” **[tell us](https://github.com/polkadot-developers/polkadot-docs/issues/new?template=docs-issue.yml){target=\_blank}**. Your feedback makes the whole ecosystem better for everyone. + +## Support Channels Use one of the channels below to get live technical support or ask questions. -
- - Connect to Telegram - - - Connect to Discord - +
+ +- :simple-telegram:{ .sub } **Telegram: Polkadot Developer Support** + + + + πŸ‘‰ [Join Telegram](https://t.me/substratedevs){target=\_blank} + +- :simple-discord:{ .sub } **Discord: Polkadot Official Server** + + + + πŸ‘‰ [Join Discord](https://polkadot-discord.w3f.tools/){target=\_blank} + +- :simple-matrix:{ .sub } **Matrix: Polkadot Developer Support** + + + + πŸ‘‰ [Join Matrix](https://matrix.to/#/#substratedevs:matrix.org){target=\_blank} +
+## Community Resources + +
-## Need More than Just Documentation? +- :fontawesome-brands-stack-exchange:{ .sub } **Stack Exchange** + + -You're already in the docs β€” solid start. -But sometimes you need more: answers, real examples, someone to talk to. -This support hub is here to help you move forward β€” faster. + πŸ‘‰ [Visit Polkadot Stack Exchange](https://substrate.stackexchange.com/){target=\_blank} -Whether you're building something new, integrating into the ecosystem, or running into blockers β€” **don't stay stuck**. +- :simple-reddit:{ .sub } **Reddit: r/Polkadot** + + -## What You Can Do Here + πŸ‘‰ [Visit r/Polkadot](https://www.reddit.com/r/Polkadot/){target=\_blank} -- πŸ“¨ [**Get In Touch**](/get-support/get-in-touch/) - Reach out to the Polkadot support team and community via Telegram, Matrix, or Discord. - Ask technical questions, report blockers, or share feedback β€” and get a human response. +- :simple-youtube:{ .sub } **YouTube: @PolkadotNetwork** + + -- 🧠 [**Explore Available Resources**](/get-support/explore-resources/) - Find answers beyond the documentation: developer forums, Stack Exchange, Reddit, YouTube, governance hubs, and more. + πŸ‘‰ [Watch on YouTube](https://www.youtube.com/@PolkadotNetwork){target=\_blank} -This hub is evolving. More support tools and shortcuts are on the way, including enhanced onboarding, CLI helpers, development environments, and live feedback channels. +- :fontawesome-brands-x-twitter:{ .sub } **X (Twitter): Official Accounts** + + - **[@PolkadotDevs](https://x.com/PolkadotDevs){target=\_blank}**: Updates for developers. + - **[@Polkadot](https://x.com/Polkadot){target=\_blank}**: Network-wide news. + - **[@Kusamanetwork](https://x.com/kusamanetwork){target=\_blank}**: Kusama-specific updates. + - **[@Web3Foundation](https://x.com/web3foundation){target=\_blank}**: Grants, research, and ecosystem programs. -## Help Us Improve +- :fontawesome-brands-x-twitter:{ .sub } **X (Twitter): Community Accounts** -If something’s missing, unclear, or broken β€” **tell us**. -Your feedback makes the whole ecosystem better for everyone. + - **[@PolkadotDeploy](https://x.com/PolkadotDeploy){target=\_blank}**: News from the deployment portal and tooling updates. -πŸ‘‰ [**Get In Touch**](/get-support/get-in-touch/) and help shape the future of developer support. +- :material-forum:{ .sub } **Polkadot Forum** + + + + πŸ‘‰ [Visit the Polkadot Forum](https://forum.polkadot.network/){target=\_blank} + +- :material-vote:{ .sub } **Polkassembly: OpenGov** + + + + πŸ‘‰ [Explore on Polkassembly](https://polkadot.polkassembly.io/){target=\_blank} + +
+ +## AI Resources + +
+ +- :fontawesome-solid-robot:{ .sub } **AI Ready Documentation** + + Access documentation structured and optimized for use with large language models (LLMs) and AI tools. These resources help build AI assistants, power code search, or enable custom tooling trained on Polkadot’s documentation. + + πŸ‘‰ [Access LLM Files](/get-support/ai-ready-docs/){target=\_blank} + +
diff --git a/.ai/site-index.json b/.ai/site-index.json index 8e128afce..87da38bc1 100644 --- a/.ai/site-index.json +++ b/.ai/site-index.json @@ -17,129 +17,17 @@ }, { "depth": 2, - "title": "Download LLM Files", - "anchor": "download-llm-files" + "title": "Access LLM Files", + "anchor": "access-llm-files" } ], "stats": { - "chars": 7998, + "chars": 7996, "words": 825, "headings": 2, "estimated_token_count_total": 2232 }, - "hash": "sha256:5a8da69a5cea8bd598ee4d102b9abed5d1a29153802a567e22bb4ee720410b32", - "token_estimator": "heuristic-v1" - }, - { - "id": "get-support-explore-resources", - "title": "Subscribe to Updates", - "slug": "get-support-explore-resources", - "categories": [ - "Uncategorized" - ], - "raw_md_url": "https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/get-support-explore-resources.md", - "html_url": "https://docs.polkadot.com/get-support/explore-resources/", - "preview": "Looking for answers beyond the documentation? These platforms are full of useful content and experienced developers sharing insights.", - "outline": [ - { - "depth": 2, - "title": "🧠 Stack Exchange", - "anchor": "stack-exchange" - }, - { - "depth": 2, - "title": "🧡 Reddit: r/Polkadot", - "anchor": "reddit-rpolkadot" - }, - { - "depth": 2, - "title": "πŸ’¬ Discord (Community Threads Only)", - "anchor": "discord-community-threads-only" - }, - { - "depth": 2, - "title": "πŸŽ₯ YouTube: @PolkadotNetwork", - "anchor": "youtube-polkadotnetwork" - }, - { - "depth": 2, - "title": "Community-Led Platforms and Ecosystem Updates", - "anchor": "community-led-platforms-and-ecosystem-updates" - }, - { - "depth": 3, - "title": "πŸ”· X (Twitter): Official Accounts", - "anchor": "x-twitter-official-accounts" - }, - { - "depth": 3, - "title": "πŸ” X (Twitter): Community Accounts", - "anchor": "x-twitter-community-accounts" - }, - { - "depth": 3, - "title": "πŸ—£οΈ Polkadot Forum", - "anchor": "polkadot-forum" - }, - { - "depth": 3, - "title": "πŸ§‘β€βš–οΈ Polkassembly: OpenGov", - "anchor": "polkassembly-opengov" - }, - { - "depth": 3, - "title": "πŸ“Έ Instagram", - "anchor": "instagram" - } - ], - "stats": { - "chars": 2426, - "words": 295, - "headings": 10, - "estimated_token_count_total": 579 - }, - "hash": "sha256:670221ac20ab1f1b550ba2a1db06cd924c24bd3afc4d8a768b617d8a409243cb", - "token_estimator": "heuristic-v1" - }, - { - "id": "get-support-get-in-touch", - "title": "Get in Touch", - "slug": "get-support-get-in-touch", - "categories": [ - "Uncategorized" - ], - "raw_md_url": "https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/get-support-get-in-touch.md", - "html_url": "https://docs.polkadot.com/get-support/get-in-touch/", - "preview": "Use one of the channels below to get live technical support or ask questions.", - "outline": [ - { - "depth": 2, - "title": "Need Help Fast?", - "anchor": "need-help-fast" - }, - { - "depth": 2, - "title": "πŸ“± Telegram: Polkadot Developer Support", - "anchor": "telegram-polkadot-developer-support" - }, - { - "depth": 2, - "title": "πŸ”Œ Discord: Polkadot Official Server", - "anchor": "discord-polkadot-official-server" - }, - { - "depth": 2, - "title": "🧬 Matrix: Polkadot Developer Support", - "anchor": "matrix-polkadot-developer-support" - } - ], - "stats": { - "chars": 1949, - "words": 258, - "headings": 4, - "estimated_token_count_total": 557 - }, - "hash": "sha256:993e93b05c8fbdfc2f7510c61ac86bc4c2ff0f03e573695b2f260933c8b62f78", + "hash": "sha256:1aa997c6fecf9ff5f6b2fde718c928518d6697bb818f71aa391fbb38a1946ff4", "token_estimator": "heuristic-v1" }, { @@ -151,31 +39,31 @@ ], "raw_md_url": "https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/get-support.md", "html_url": "https://docs.polkadot.com/get-support/", - "preview": "Use one of the channels below to get live technical support or ask questions.", + "preview": "You're already in the docs β€” solid start. But sometimes you need more: answers, real examples, someone to talk to. This support hub is here to help you move forward β€” faster.", "outline": [ { "depth": 2, - "title": "Need More than Just Documentation?", - "anchor": "need-more-than-just-documentation" + "title": "Support Channels", + "anchor": "support-channels" }, { "depth": 2, - "title": "What You Can Do Here", - "anchor": "what-you-can-do-here" + "title": "Community Resources", + "anchor": "community-resources" }, { "depth": 2, - "title": "Help Us Improve", - "anchor": "help-us-improve" + "title": "AI Resources", + "anchor": "ai-resources" } ], "stats": { - "chars": 1658, - "words": 244, + "chars": 4621, + "words": 579, "headings": 3, - "estimated_token_count_total": 280 + "estimated_token_count_total": 1223 }, - "hash": "sha256:5bdc575ac798a971867a15651c2b4d5139bf0b1fe6854d1865deff280ae6d7f6", + "hash": "sha256:69e5bcd8ec2f35e39ff674b7f709c7526dd34427ddd66d449ecb01d29a405321", "token_estimator": "heuristic-v1" }, { diff --git a/llms-full.jsonl b/llms-full.jsonl index d33116801..bd11b3e13 100644 --- a/llms-full.jsonl +++ b/llms-full.jsonl @@ -1,22 +1,8 @@ {"page_id": "get-support-ai-ready-docs", "page_title": "AI Ready Docs", "index": 0, "depth": 2, "title": "How to Use These Files", "anchor": "how-to-use-these-files", "start_char": 286, "end_char": 952, "estimated_token_count": 164, "token_estimator": "heuristic-v1", "text": "## How to Use These Files\n\n- **Quick navigation**: Use `llms.txt` to give models a high-level map of the site.\n- **Lightweight context**: Use `site-index.json` for smaller context windows or when you only need targeted retrieval.\n- **Full content**: Use `llms-full.jsonl` for large-context models or preparing data for RAG pipelines.\n- **Focused bundles**: Use category files (e.g., `basics.md`, `parachains.md`) to limit content to a specific theme or task for more focused responses.\n\nThese AI-ready files do not include any persona or system prompts. They are purely informational and can be used without conflicting with your existing agent or tool prompting."} -{"page_id": "get-support-ai-ready-docs", "page_title": "AI Ready Docs", "index": 1, "depth": 2, "title": "Download LLM Files", "anchor": "download-llm-files", "start_char": 952, "end_char": 7998, "estimated_token_count": 2068, "token_estimator": "heuristic-v1", "text": "## Download LLM Files\n\n| Category | Description | File | Actions |\n|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Index | Markdown URL index for documentation pages, links to essential repos, and additional resources in the llms.txt standard format. | llms.txt |
[:octicons-copy-16:](){ .llms-copy data-path=\"/llms.txt\" } [:octicons-download-16:](){ .llms-dl data-path=\"/llms.txt\" data-filename=\"llms.txt\" }
|\n| Site index (JSON) | Lightweight site index of JSON objects (one per page) with metadata and content previews. | site-index.json |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/site-index.json\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/site-index.json\" data-filename=\"site-index.json\" }
|\n| Full site contents (JSONL) | Full content of documentation site enhanced with metadata. | llms-full.jsonl |
[:octicons-copy-16:](){ .llms-copy data-path=\"/llms-full.jsonl\" } [:octicons-download-16:](){ .llms-dl data-path=\"/llms-full.jsonl\" data-filename=\"llms-full.jsonl\" }
|\n| Basics | Polkadot general knowledge base to provide context around overview and beginner-level content. | basics.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/basics.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/basics.md\" data-filename=\"basics.md\" }
|\n| Reference | Reference material including key functions and glossary. | reference.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/reference.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/reference.md\" data-filename=\"reference.md\" }
|\n| Smart Contracts | How to develop and deploy Solidity smart contracts on Polkadot Hub. | smart-contracts.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/smart-contracts.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/smart-contracts.md\" data-filename=\"smart-contracts.md\" }
|\n| Parachains | How-to guides related to building, customizing, deploying, and maintaining a parachain. | parachains.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/parachains.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/parachains.md\" data-filename=\"parachains.md\" }
|\n| DApps | Information and tutorials for application developers. | dapps.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/dapps.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/dapps.md\" data-filename=\"dapps.md\" }
|\n| Networks | Information about the various Polkadot networks (Polkadot, Kusama, Westend, Paseo), their purposes, and how they fit into the development workflow. | networks.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/networks.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/networks.md\" data-filename=\"networks.md\" }
|\n| Polkadot Protocol | Polkadot's core architecture, including the relay chain, parachains, system chains, interoperability, and main actors. | polkadot-protocol.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/polkadot-protocol.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/polkadot-protocol.md\" data-filename=\"polkadot-protocol.md\" }
|\n| Infrastructure | Operational aspects of supporting the Polkadot network, including how to run a node or validator and staking mechanics. | infrastructure.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/infrastructure.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/infrastructure.md\" data-filename=\"infrastructure.md\" }
|\n| Tooling | An overview of various development tools available for Polkadot development. | tooling.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/tooling.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/tooling.md\" data-filename=\"tooling.md\" }
|\n\n!!! note\n The `llms-full.jsonl` file may exceed the input limits of some language models due to its size. If you encounter limitations, consider using the smaller `site-index.json` or category bundle files instead."} -{"page_id": "get-support-explore-resources", "page_title": "Subscribe to Updates", "index": 0, "depth": 2, "title": "🧠 Stack Exchange", "anchor": "stack-exchange", "start_char": 178, "end_char": 403, "estimated_token_count": 53, "token_estimator": "heuristic-v1", "text": "## 🧠 Stack Exchange\n\n- Browse commonly asked technical questions.\n- Ask your own and get detailed responses from experienced devs.\n\nπŸ‘‰ **[Visit Polkadot Stack Exchange](https://substrate.stackexchange.com/){target=\\_blank}**"} -{"page_id": "get-support-explore-resources", "page_title": "Subscribe to Updates", "index": 1, "depth": 2, "title": "🧡 Reddit: r/Polkadot", "anchor": "reddit-rpolkadot", "start_char": 403, "end_char": 631, "estimated_token_count": 60, "token_estimator": "heuristic-v1", "text": "## 🧡 Reddit: r/Polkadot\n\n- General Polkadot discussions and community perspectives.\n- Developer questions are welcome β€” just tag them appropriately.\n\nπŸ‘‰ **[Visit r/Polkadot](https://www.reddit.com/r/Polkadot/){target=\\_blank}**"} -{"page_id": "get-support-explore-resources", "page_title": "Subscribe to Updates", "index": 2, "depth": 2, "title": "πŸ’¬ Discord (Community Threads Only)", "anchor": "discord-community-threads-only", "start_char": 631, "end_char": 900, "estimated_token_count": 66, "token_estimator": "heuristic-v1", "text": "## πŸ’¬ Discord (Community Threads Only)\n\n- Beyond the official support threads, most channels are community-driven.\n- Great place to connect with fellow builders and share insights.\n\nπŸ‘‰ **[Join the Polkadot Discord](https://polkadot-discord.w3f.tools/){target=\\_blank}**"} -{"page_id": "get-support-explore-resources", "page_title": "Subscribe to Updates", "index": 3, "depth": 2, "title": "πŸŽ₯ YouTube: @PolkadotNetwork", "anchor": "youtube-polkadotnetwork", "start_char": 900, "end_char": 1098, "estimated_token_count": 48, "token_estimator": "heuristic-v1", "text": "## πŸŽ₯ YouTube: @PolkadotNetwork\n\n- Developer tutorials\n- Ecosystem interviews\n- Event recordings and walkthroughs\n\nπŸ‘‰ **[Watch on YouTube](https://www.youtube.com/@PolkadotNetwork){target=\\_blank}**"} -{"page_id": "get-support-explore-resources", "page_title": "Subscribe to Updates", "index": 4, "depth": 2, "title": "Community-Led Platforms and Ecosystem Updates", "anchor": "community-led-platforms-and-ecosystem-updates", "start_char": 1098, "end_char": 1298, "estimated_token_count": 34, "token_estimator": "heuristic-v1", "text": "## Community-Led Platforms and Ecosystem Updates\n\nStay in sync with what's happening across the Polkadot ecosystem β€” from official announcements to community-driven insights and governance activity."} -{"page_id": "get-support-explore-resources", "page_title": "Subscribe to Updates", "index": 5, "depth": 3, "title": "πŸ”· X (Twitter): Official Accounts", "anchor": "x-twitter-official-accounts", "start_char": 1298, "end_char": 1693, "estimated_token_count": 121, "token_estimator": "heuristic-v1", "text": "### πŸ”· X (Twitter): Official Accounts\n\n- [@PolkadotDevs](https://x.com/PolkadotDevs){target=\\_blank}: Updates for developers\n- [@Polkadot](https://x.com/Polkadot){target=\\_blank}: Network-wide news\n- [@Kusamanetwork](https://x.com/kusamanetwork){target=\\_blank}: Kusama-specific updates\n- [@Web3Foundation](https://x.com/web3foundation){target=\\_blank}: Grants, research, and ecosystem programs"} -{"page_id": "get-support-explore-resources", "page_title": "Subscribe to Updates", "index": 6, "depth": 3, "title": "πŸ” X (Twitter): Community Accounts", "anchor": "x-twitter-community-accounts", "start_char": 1693, "end_char": 1852, "estimated_token_count": 42, "token_estimator": "heuristic-v1", "text": "### πŸ” X (Twitter): Community Accounts\n\n- [@PolkadotDeploy](https://x.com/PolkadotDeploy){target=\\_blank}: News from the deployment portal and tooling updates"} -{"page_id": "get-support-explore-resources", "page_title": "Subscribe to Updates", "index": 7, "depth": 3, "title": "πŸ—£οΈ Polkadot Forum", "anchor": "polkadot-forum", "start_char": 1852, "end_char": 2027, "estimated_token_count": 47, "token_estimator": "heuristic-v1", "text": "### πŸ—£οΈ Polkadot Forum\n\n- Join community discussions around the direction of the ecosystem.\n\nπŸ‘‰ **[Visit the Polkadot Forum](https://forum.polkadot.network/){target=\\_blank}**"} -{"page_id": "get-support-explore-resources", "page_title": "Subscribe to Updates", "index": 8, "depth": 3, "title": "πŸ§‘β€βš–οΈ Polkassembly: OpenGov", "anchor": "polkassembly-opengov", "start_char": 2027, "end_char": 2252, "estimated_token_count": 59, "token_estimator": "heuristic-v1", "text": "### πŸ§‘β€βš–οΈ Polkassembly: OpenGov\n\n- Explore and vote on governance proposals for Polkadot and Kusama.\n- Help shape the future of the network.\n\nπŸ‘‰ **[Explore on Polkassembly](https://polkadot.polkassembly.io/){target=\\_blank}**"} -{"page_id": "get-support-explore-resources", "page_title": "Subscribe to Updates", "index": 9, "depth": 3, "title": "πŸ“Έ Instagram", "anchor": "instagram", "start_char": 2252, "end_char": 2426, "estimated_token_count": 49, "token_estimator": "heuristic-v1", "text": "### πŸ“Έ Instagram\n\n- **[@Polkadotnetwork](https://www.instagram.com/polkadotnetwork){target=\\_blank}**: Visual highlights from the ecosystem\n _(Note: not developer-specific)_"} -{"page_id": "get-support-get-in-touch", "page_title": "Get in Touch", "index": 0, "depth": 2, "title": "Need Help Fast?", "anchor": "need-help-fast", "start_char": 25, "end_char": 546, "estimated_token_count": 152, "token_estimator": "heuristic-v1", "text": "## Need Help Fast?\n \nUse one of the channels below to get live technical support or ask questions.\n\n
\n \n Connect to Telegram\n \n \n Connect to Discord\n \n
\n\nPrefer to see all available channels? Below are your options."} -{"page_id": "get-support-get-in-touch", "page_title": "Get in Touch", "index": 1, "depth": 2, "title": "πŸ“± Telegram: Polkadot Developer Support", "anchor": "telegram-polkadot-developer-support", "start_char": 546, "end_char": 876, "estimated_token_count": 94, "token_estimator": "heuristic-v1", "text": "## πŸ“± Telegram: Polkadot Developer Support\n\nThe fastest way to get support.\n\n- **Who’s there:** DevRel team and active developer community.\n- **Response time:** Within **2 business days (usually faster)**.\n- **Topics:** Any developer-related question is welcome.\n\nπŸ‘‰ **[Join Telegram](https://t.me/substratedevs){target=\\_blank}**"} -{"page_id": "get-support-get-in-touch", "page_title": "Get in Touch", "index": 2, "depth": 2, "title": "πŸ”Œ Discord: Polkadot Official Server", "anchor": "discord-polkadot-official-server", "start_char": 876, "end_char": 1328, "estimated_token_count": 128, "token_estimator": "heuristic-v1", "text": "## πŸ”Œ Discord: Polkadot Official Server\n\nFocused support for smart contracts and general developer chat.\n\n- **Smart contracts:** Ask in `#solidity-smart-contracts` and `#ink_smart-contracts`.\n- **General developer support:** Ask in `#solidity-smart-contracts`.\n- **Response time:** Within **1 business day (usually faster)**.\n- **Other topics:** Community-led discussion only.\n\nπŸ‘‰ **[Join Discord](https://polkadot-discord.w3f.tools/){target=\\_blank}**"} -{"page_id": "get-support-get-in-touch", "page_title": "Get in Touch", "index": 3, "depth": 2, "title": "🧬 Matrix: Polkadot Developer Support", "anchor": "matrix-polkadot-developer-support", "start_char": 1328, "end_char": 1949, "estimated_token_count": 183, "token_estimator": "heuristic-v1", "text": "## 🧬 Matrix: Polkadot Developer Support\n\nThis is the **support channel** staffed by engineers from **Parity**, **Web3 Foundation**, and **Polkadot DevRel**.\n\n- **Who’s there:** Parity, W3F, DevRel, and community contributors.\n- **Response time:** Within **1 business day (usually faster)**.\n- **Topics:** Full-spectrum developer support.\n- Bridged with Telegram (all messages synced).\n\nπŸ‘‰ **[Join Matrix](https://matrix.to/#/#substratedevs:matrix.org){target=\\_blank}**\n\n---\n\nNot sure where to start? \n\n**Join [Telegram](#telegram-polkadot-developer-support)**: Let us know what you need, and we’ll help you get unstuck."} -{"page_id": "get-support", "page_title": "Support", "index": 0, "depth": 2, "title": "Need More than Just Documentation?", "anchor": "need-more-than-just-documentation", "start_char": 456, "end_char": 796, "estimated_token_count": 76, "token_estimator": "heuristic-v1", "text": "## Need More than Just Documentation?\n\nYou're already in the docs β€” solid start. \nBut sometimes you need more: answers, real examples, someone to talk to. \nThis support hub is here to help you move forward β€” faster.\n\nWhether you're building something new, integrating into the ecosystem, or running into blockers β€” **don't stay stuck**."} -{"page_id": "get-support", "page_title": "Support", "index": 1, "depth": 2, "title": "What You Can Do Here", "anchor": "what-you-can-do-here", "start_char": 796, "end_char": 1419, "estimated_token_count": 139, "token_estimator": "heuristic-v1", "text": "## What You Can Do Here\n\n- πŸ“¨ [**Get In Touch**](/get-support/get-in-touch/) \n Reach out to the Polkadot support team and community via Telegram, Matrix, or Discord. \n Ask technical questions, report blockers, or share feedback β€” and get a human response.\n\n- 🧠 [**Explore Available Resources**](/get-support/explore-resources/) \n Find answers beyond the documentation: developer forums, Stack Exchange, Reddit, YouTube, governance hubs, and more.\n\nThis hub is evolving. More support tools and shortcuts are on the way, including enhanced onboarding, CLI helpers, development environments, and live feedback channels."} -{"page_id": "get-support", "page_title": "Support", "index": 2, "depth": 2, "title": "Help Us Improve", "anchor": "help-us-improve", "start_char": 1419, "end_char": 1658, "estimated_token_count": 65, "token_estimator": "heuristic-v1", "text": "## Help Us Improve\n\nIf something’s missing, unclear, or broken β€” **tell us**. \nYour feedback makes the whole ecosystem better for everyone.\n\nπŸ‘‰ [**Get In Touch**](/get-support/get-in-touch/) and help shape the future of developer support."} +{"page_id": "get-support-ai-ready-docs", "page_title": "AI Ready Docs", "index": 1, "depth": 2, "title": "Access LLM Files", "anchor": "access-llm-files", "start_char": 952, "end_char": 7996, "estimated_token_count": 2068, "token_estimator": "heuristic-v1", "text": "## Access LLM Files\n\n| Category | Description | File | Actions |\n|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Index | Markdown URL index for documentation pages, links to essential repos, and additional resources in the llms.txt standard format. | llms.txt |
[:octicons-copy-16:](){ .llms-copy data-path=\"/llms.txt\" } [:octicons-download-16:](){ .llms-dl data-path=\"/llms.txt\" data-filename=\"llms.txt\" }
|\n| Site index (JSON) | Lightweight site index of JSON objects (one per page) with metadata and content previews. | site-index.json |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/site-index.json\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/site-index.json\" data-filename=\"site-index.json\" }
|\n| Full site contents (JSONL) | Full content of documentation site enhanced with metadata. | llms-full.jsonl |
[:octicons-copy-16:](){ .llms-copy data-path=\"/llms-full.jsonl\" } [:octicons-download-16:](){ .llms-dl data-path=\"/llms-full.jsonl\" data-filename=\"llms-full.jsonl\" }
|\n| Basics | Polkadot general knowledge base to provide context around overview and beginner-level content. | basics.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/basics.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/basics.md\" data-filename=\"basics.md\" }
|\n| Reference | Reference material including key functions and glossary. | reference.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/reference.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/reference.md\" data-filename=\"reference.md\" }
|\n| Smart Contracts | How to develop and deploy Solidity smart contracts on Polkadot Hub. | smart-contracts.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/smart-contracts.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/smart-contracts.md\" data-filename=\"smart-contracts.md\" }
|\n| Parachains | How-to guides related to building, customizing, deploying, and maintaining a parachain. | parachains.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/parachains.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/parachains.md\" data-filename=\"parachains.md\" }
|\n| DApps | Information and tutorials for application developers. | dapps.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/dapps.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/dapps.md\" data-filename=\"dapps.md\" }
|\n| Networks | Information about the various Polkadot networks (Polkadot, Kusama, Westend, Paseo), their purposes, and how they fit into the development workflow. | networks.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/networks.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/networks.md\" data-filename=\"networks.md\" }
|\n| Polkadot Protocol | Polkadot's core architecture, including the relay chain, parachains, system chains, interoperability, and main actors. | polkadot-protocol.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/polkadot-protocol.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/polkadot-protocol.md\" data-filename=\"polkadot-protocol.md\" }
|\n| Infrastructure | Operational aspects of supporting the Polkadot network, including how to run a node or validator and staking mechanics. | infrastructure.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/infrastructure.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/infrastructure.md\" data-filename=\"infrastructure.md\" }
|\n| Tooling | An overview of various development tools available for Polkadot development. | tooling.md |
[:octicons-copy-16:](){ .llms-copy data-path=\"/ai/categories/tooling.md\" } [:octicons-download-16:](){ .llms-dl data-path=\"/ai/categories/tooling.md\" data-filename=\"tooling.md\" }
|\n\n!!! note\n The `llms-full.jsonl` file may exceed the input limits of some language models due to its size. If you encounter limitations, consider using the smaller `site-index.json` or category bundle files instead."} +{"page_id": "get-support", "page_title": "Support", "index": 0, "depth": 2, "title": "Support Channels", "anchor": "support-channels", "start_char": 433, "end_char": 1896, "estimated_token_count": 453, "token_estimator": "heuristic-v1", "text": "## Support Channels\n\nUse one of the channels below to get live technical support or ask questions.\n\n
\n\n- :simple-telegram:{ .sub } **Telegram: Polkadot Developer Support**\n\n \n\n πŸ‘‰ [Join Telegram](https://t.me/substratedevs){target=\\_blank}\n\n- :simple-discord:{ .sub } **Discord: Polkadot Official Server**\n \n \n\n πŸ‘‰ [Join Discord](https://polkadot-discord.w3f.tools/){target=\\_blank}\n\n- :simple-matrix:{ .sub } **Matrix: Polkadot Developer Support**\n\n \n\n πŸ‘‰ [Join Matrix](https://matrix.to/#/#substratedevs:matrix.org){target=\\_blank}\n\n
"} +{"page_id": "get-support", "page_title": "Support", "index": 1, "depth": 2, "title": "Community Resources", "anchor": "community-resources", "start_char": 1896, "end_char": 4187, "estimated_token_count": 667, "token_estimator": "heuristic-v1", "text": "## Community Resources\n\n
\n\n- :fontawesome-brands-stack-exchange:{ .sub } **Stack Exchange**\n \n \n\n πŸ‘‰ [Visit Polkadot Stack Exchange](https://substrate.stackexchange.com/){target=\\_blank}\n\n- :simple-reddit:{ .sub } **Reddit: r/Polkadot**\n \n \n\n πŸ‘‰ [Visit r/Polkadot](https://www.reddit.com/r/Polkadot/){target=\\_blank}\n\n- :simple-youtube:{ .sub } **YouTube: @PolkadotNetwork**\n \n \n\n πŸ‘‰ [Watch on YouTube](https://www.youtube.com/@PolkadotNetwork){target=\\_blank}\n\n- :fontawesome-brands-x-twitter:{ .sub } **X (Twitter): Official Accounts**\n \n - **[@PolkadotDevs](https://x.com/PolkadotDevs){target=\\_blank}**: Updates for developers.\n - **[@Polkadot](https://x.com/Polkadot){target=\\_blank}**: Network-wide news.\n - **[@Kusamanetwork](https://x.com/kusamanetwork){target=\\_blank}**: Kusama-specific updates.\n - **[@Web3Foundation](https://x.com/web3foundation){target=\\_blank}**: Grants, research, and ecosystem programs.\n\n- :fontawesome-brands-x-twitter:{ .sub } **X (Twitter): Community Accounts**\n\n - **[@PolkadotDeploy](https://x.com/PolkadotDeploy){target=\\_blank}**: News from the deployment portal and tooling updates.\n\n- :material-forum:{ .sub } **Polkadot Forum**\n \n \n\n πŸ‘‰ [Visit the Polkadot Forum](https://forum.polkadot.network/){target=\\_blank}\n\n- :material-vote:{ .sub } **Polkassembly: OpenGov**\n \n \n\n πŸ‘‰ [Explore on Polkassembly](https://polkadot.polkassembly.io/){target=\\_blank}\n\n
"} +{"page_id": "get-support", "page_title": "Support", "index": 2, "depth": 2, "title": "AI Resources", "anchor": "ai-resources", "start_char": 4187, "end_char": 4621, "estimated_token_count": 103, "token_estimator": "heuristic-v1", "text": "## AI Resources\n\n
\n\n- :fontawesome-solid-robot:{ .sub } **AI Ready Documentation**\n\n Access documentation structured and optimized for use with large language models (LLMs) and AI tools. These resources help build AI assistants, power code search, or enable custom tooling trained on Polkadot’s documentation.\n\n πŸ‘‰ [Access LLM Files](/get-support/ai-ready-docs/){target=\\_blank}\n\n
"} {"page_id": "node-infrastructure-run-a-collator", "page_title": "Run a Block-Producing Collator", "index": 0, "depth": 2, "title": "Introduction", "anchor": "introduction", "start_char": 34, "end_char": 1172, "estimated_token_count": 209, "token_estimator": "heuristic-v1", "text": "## Introduction\n\nBlock-producing collators are the backbone of system parachain operations. Unlike RPC or archive nodes, which maintain state, collators actively produce blocks and submit them to relay chain validators for inclusion. They ensure network liveness, censorship resistance, and cross-chain message processing.\n\nCollators maintain fully synced relay chain and parachain nodes, aggregate transactions into blocks, create parachain block candidates, generate state transition proofs (Proof-of-Validity), and send block candidates to relay chain validators. They also enable cross-chain message handling via XCM. While critical for liveness, collators do not secure the networkβ€”security is provided by relay chain validators through the [ELVES protocol](https://wiki.polkadot.com/learn/learn-parachains-protocol/){target=\\_blank}.\n\nThis guide explains how to set up a collator for Polkadot system parachains, covering all key requirements, setting up and registering session keys, and meeting governance approval or invulnerables-list criteria (required for system parachains; non-system parachains may be more permissionless)."} {"page_id": "node-infrastructure-run-a-collator", "page_title": "Run a Block-Producing Collator", "index": 1, "depth": 2, "title": "Prerequisites", "anchor": "prerequisites", "start_char": 1172, "end_char": 1190, "estimated_token_count": 3, "token_estimator": "heuristic-v1", "text": "## Prerequisites"} {"page_id": "node-infrastructure-run-a-collator", "page_title": "Run a Block-Producing Collator", "index": 2, "depth": 3, "title": "Hardware Requirements", "anchor": "hardware-requirements", "start_char": 1190, "end_char": 1902, "estimated_token_count": 155, "token_estimator": "heuristic-v1", "text": "### Hardware Requirements\n\nBlock-producing collators require robust hardware for reliable operation, including the following:\n\n- **CPU**: 4+ cores (8+ cores recommended for optimal performance)\n- **Memory**: 32 GB RAM minimum (64 GB recommended)\n- **Storage**:\n - 200+ GB NVMe SSD (with pruning enabled for both parachain and relay chain)\n - Fast disk I/O is critical for block production performance\n- **Network**:\n - Public IP address\n - 100+ Mbps connection; a stable connection is critical\n - Open ports:\n - **30333**: Parachain P2P\n - **30334**: Relay chain P2P\n\n!!! warning \"Uptime is critical\"\n Consider redundancy and monitoring to maintain block production reliability."} diff --git a/llms.txt b/llms.txt index d8302f293..271c8f664 100644 --- a/llms.txt +++ b/llms.txt @@ -6,7 +6,7 @@ This directory lists URLs for raw Markdown pages that complement the rendered pages on the documentation site. Use these Markdown files to retain semantic context when prompting models while avoiding passing HTML elements. ## Metadata -- Documentation pages: 127 +- Documentation pages: 125 - Categories: 13 ## Docs @@ -221,8 +221,6 @@ Docs: Polkadot Hub Docs: Uncategorized - [AI Ready Docs](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/get-support-ai-ready-docs.md): Download LLM-optimized files of the Polkadot documentation, including full content and category-specific resources for AI agents. -- [Subscribe to Updates](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/get-support-explore-resources.md): Find Polkadot developer resources, tutorials, forums, governance proposals, and community platforms like StackExchange, Reddit, and YouTube. -- [Get in Touch](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/get-support-get-in-touch.md): Developer support for Polkadot via Telegram, Matrix, and Discord. Get help with parachains, smart contracts, nodes, and ecosystem tools. - [Support](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/get-support.md): Start here to get developer support for Polkadot. Connect with the team, find help, and explore resources beyond the documentation. - [Polkadot Developer Docs](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/index.md): Explore everything you need to start building on top of Polkadot, a protocol that provides parachains with shared security and interoperability using XCM. - [ParaSpell XCM SDK](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/master/.ai/pages/reference-tools-paraspell.md): A powerful open-source library that simplifies XCM integration, enabling developers to easily build interoperable dApps on Polkadot. diff --git a/reference/glossary.md b/reference/glossary.md index bbd52a46b..4a83084d3 100644 --- a/reference/glossary.md +++ b/reference/glossary.md @@ -1,7 +1,6 @@ --- title: Glossary description: Glossary of terms used within the Polkadot ecosystem, Polkadot SDK, its subsequent libraries, and other relevant Web3 terminology. -template: root-subdirectory-page.html categories: Reference ---