Skip to content

Conversation

@eshaben
Copy link
Collaborator

@eshaben eshaben commented Dec 11, 2025

📝 Description

This pull request refactors and consolidates the Polkadot developer support documentation, streamlining navigation and merging previously separate support and resource pages into a single, comprehensive hub. The new structure improves clarity, accessibility, and discoverability of support channels, community resources, and AI-ready documentation files.

Navigation and Structure Simplification

  • Removed separate navigation entries and pages for "Get In Touch Directly" and "Explore More Resources," consolidating their content into the main support index for easier access. (get-support/.nav.yml, get-support/get-in-touch.md, get-support/explore-resources.md) [1] [2] [3]

Support Hub Redesign

  • Completely redesigned get-support/index.md to serve as the central support hub, presenting all support channels (Telegram, Discord, Matrix) and community resources (Stack Exchange, Reddit, YouTube, Twitter, Forum, Polkassembly) in a unified, card-based layout for improved user experience.

Content Updates and Terminology

  • Updated headings and terminology for clarity, such as changing "Download LLM Files" to "Access LLM Files" in the AI documentation section. (get-support/ai-ready-docs.md)

Removal of Redundant Files

  • Deleted the standalone "Get In Touch" and "Explore More Resources" markdown files, as their content is now integrated into the index. (get-support/get-in-touch.md, get-support/explore-resources.md) [1] [2]

Goes with mkdocs PR papermoonio/polkadot-mkdocs#193

@eshaben eshaben requested a review from a team as a code owner December 11, 2025 05:47
Copilot AI review requested due to automatic review settings December 11, 2025 05:47
@eshaben eshaben requested a review from a team December 11, 2025 05:47
@eshaben eshaben added B0 - Needs Review Pull request is ready for review A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) labels Dec 11, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR consolidates the Polkadot developer support documentation into a single comprehensive hub by merging three separate pages into one unified support index. The refactoring streamlines navigation and improves the discoverability of support channels, community resources, and AI documentation.

Key Changes:

  • Merged "Get In Touch Directly" and "Explore More Resources" pages into the main support index
  • Redesigned the support hub with a card-based layout organizing support channels, community resources, and AI tools
  • Updated terminology from "Download LLM Files" to "Access LLM Files" in the AI documentation section

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 14 comments.

Show a summary per file
File Description
get-support/.nav.yml Removed navigation entries for "Get In Touch Directly" and "Explore More Resources", consolidating navigation to just the index and AI docs
get-support/index.md Complete redesign as a unified support hub with card-based layout for support channels (Telegram, Discord, Matrix), community resources (Stack Exchange, Reddit, YouTube, X/Twitter, Forum, Polkassembly), and AI resources
get-support/get-in-touch.md Deleted file with content migrated to the index page
get-support/explore-resources.md Deleted file with content migrated to the index page
get-support/ai-ready-docs.md Updated section heading from "Download LLM Files" to "Access LLM Files" for better clarity

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

<li> Help shape the future of the network. </li>
</ul>

👉 **[Explore on Polkassembly](https://polkadot.polkassembly.io/){target=\_blank}**
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The escape character before the underscore in target=\_blank is incorrect. It should be target=_blank without the backslash. This appears throughout the file and will result in malformed HTML attributes.

Copilot uses AI. Check for mistakes.

If something’s missing, unclear, or broken — **tell us**.
Your feedback makes the whole ecosystem better for everyone.
👉 **[Access LLM Files](/get-support/ai-ready-docs/){target=\_blank}**
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The escape character before the underscore in target=\_blank is incorrect. It should be target=_blank without the backslash. This appears throughout the file and will result in malformed HTML attributes.

Copilot uses AI. Check for mistakes.

<ul class="card-list">
<li> **Smart contracts:** Ask in `#solidity-smart-contracts` and `#ink_smart-contracts`. </li>
<li> **General developer support:** Ask in `#solidity-smart-contracts`. </li>
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Discord general developer support directs users to ask in #solidity-smart-contracts, which appears to be a smart contract-specific channel. This is inconsistent with "general developer support" and may confuse developers with non-smart-contract questions. Consider specifying a dedicated general support channel or clarifying that general questions should go to a different channel.

Suggested change
<li> **General developer support:** Ask in `#solidity-smart-contracts`. </li>
<li> **General developer support:** Ask in `#dev-support` (for general questions) or the most relevant channel for your topic. </li>

Copilot uses AI. Check for mistakes.
👉 **[Join Telegram](https://t.me/substratedevs){target=\_blank}**

- :simple-discord:{ .sub } **Discord: Polkadot Official Server**

Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line contains trailing whitespace that should be removed for consistency and cleaner code.

Suggested change

Copilot uses AI. Check for mistakes.

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.
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The escape character before the underscore in target=\_blank is incorrect. It should be target=_blank without the backslash. This appears throughout the file and will result in malformed HTML attributes.

Copilot uses AI. Check for mistakes.
Comment on lines +87 to +90
- **[@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.
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The escape character before the underscore in target=\_blank is incorrect. It should be target=_blank without the backslash. This appears throughout the file and will result in malformed HTML attributes.

Copilot uses AI. Check for mistakes.
<li> Event recordings and walkthroughs. </li>
</ul>

👉 **[Watch on YouTube](https://www.youtube.com/@PolkadotNetwork){target=\_blank}**
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The escape character before the underscore in target=\_blank is incorrect. It should be target=_blank without the backslash. This appears throughout the file and will result in malformed HTML attributes.

Copilot uses AI. Check for mistakes.

- :fontawesome-brands-x-twitter:{ .sub } **X (Twitter): Community Accounts**

- **[@PolkadotDeploy](https://x.com/PolkadotDeploy){target=\_blank}**: News from the deployment portal and tooling updates.
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The escape character before the underscore in target=\_blank is incorrect. It should be target=_blank without the backslash. This appears throughout the file and will result in malformed HTML attributes.

Copilot uses AI. Check for mistakes.
<li> Join community discussions around the direction of the ecosystem. </li>
</ul>

👉 **[Visit the Polkadot Forum](https://forum.polkadot.network/){target=\_blank}**
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The escape character before the underscore in target=\_blank is incorrect. It should be target=_blank without the backslash. This appears throughout the file and will result in malformed HTML attributes.

Copilot uses AI. Check for mistakes.
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated style guide suggestions (1-1 of 1)

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issue: Heading uses imperative verb form when content appears to be reference material

Suggested change
## Access LLM Files
## Available LLM Files

Copy link
Collaborator

@nhussein11 nhussein11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! @eshaben, would it be possible to align the body paragraph of these two cards? "Join community ...." seems to be a bit below of the line of "@PolkadotDeploy"

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) B0 - Needs Review Pull request is ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants