chore(docs): update community links and add website reference - #88
Conversation
- Replaced and expanded community links with Community Forum and Telegram for better user engagement. - Included a new website link for centralized documentation and latest updates. - Updated FAQ, guides, and README for consistency with the revised community resources.
There was a problem hiding this comment.
Pull request overview
This PR updates community support links and adds website references across the project's documentation to improve user engagement and accessibility. The changes promote the new community forum at community.kirilov.dev while maintaining the existing Telegram channel, and add prominent links to the official website (rewatch.kirilov.dev) for centralized documentation access.
Key Changes:
- Added official website links to docs/index.md and README.md for centralized documentation
- Replaced single Telegram link with dual-channel approach: Community Forum (primary) and Telegram (real-time chat)
- Added repo_url to mkdocs.yml for better GitHub integration
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Added repo_url field to link documentation site to GitHub repository |
| docs/index.md | Added website section and updated support links to include both Community Forum and Telegram Chat |
| docs/faq.md | Updated help section and footer to reference both Community Forum and Telegram with clarified roles |
| docs/detailed_guide.md | Updated community support links and added Community Forum to quick links section |
| README.md | Reorganized Community & Support section to feature website, community forum, and Telegram with clear descriptions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **💬 Join our community**: [Telegram group](https://t.me/+eFftKWGVvSpiZjZk) - Get help from other users | ||
| **A:** | ||
| - **💬 Join our community**: [Community Forum](https://community.kirilov.dev/t/re-watch) - Get help from other users | ||
| - **💬 Telegram group**: [Telegram Chat](https://t.me/+eFftKWGVvSpiZjZk) - Real-time support |
There was a problem hiding this comment.
The Telegram link text "Telegram Chat" is inconsistent with other occurrences in the documentation. In detailed_guide.md it's called "Telegram Community" (title case), and in README.md and faq.md line 302 it's "Telegram community" (lowercase). Consider standardizing to one naming convention across all documentation files.
There was a problem hiding this comment.
@copilot open a new pull request to apply changes based on this feedback
- Replaced and expanded community links with Community Forum and Telegram for better user engagement. - Included a new website link for centralized documentation and latest updates. - Updated FAQ, guides, and README for consistency with the revised community resources.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
[WIP] Update community links and website reference based on feedback
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - README: readme.md | ||
| - Changelog: ../CHANGELOG.md | ||
| - Community: https://t.me/+eFftKWGVvSpiZjZk | ||
| - Live chat: https://t.me/+eFftKWGVvSpiZjZk |
There was a problem hiding this comment.
The navigation item label "Live chat" may be misleading as it suggests a live chat feature on the website, when it actually links to Telegram. Consider using a more descriptive label like "Telegram" or "Telegram Chat" to make it clear where users will be directed.
| - Live chat: https://t.me/+eFftKWGVvSpiZjZk | |
| - Telegram Chat: https://t.me/+eFftKWGVvSpiZjZk |
| ## 🤝 Community & Support | ||
|
|
||
| - 💬 **[Join our Telegram community](https://t.me/+eFftKWGVvSpiZjZk)** - Get help, share tips, and connect with other users | ||
| - 🌐 **[Visit our website](https://rewatch.kirilov.dev/)** - Complete documentation and guides |
There was a problem hiding this comment.
The description "Complete documentation and guides" differs from the description used in docs/index.md (line 20) which says "Complete documentation, guides, and latest updates". Consider using consistent wording across files to maintain uniformity in how the website is described to users.
| - 🌐 **[Visit our website](https://rewatch.kirilov.dev/)** - Complete documentation and guides | |
| - 🌐 **[Visit our website](https://rewatch.kirilov.dev/)** - Complete documentation, guides, and latest updates |
|
|
||
| - 💬 **[Join our Telegram community](https://t.me/+eFftKWGVvSpiZjZk)** - Get help, share tips, and connect with other users | ||
| - 🌐 **[Visit our website](https://rewatch.kirilov.dev/)** - Complete documentation and guides | ||
| - 💬 **[Join our community forum](https://community.kirilov.dev/t/re-watch)** - Get help, share tips, and connect with other users |
There was a problem hiding this comment.
The link text uses lowercase "community forum" while other documentation files consistently use title case "Community Forum" (see docs/index.md:193, docs/faq.md:278, docs/detailed_guide.md:373, 427). Consider using "Community Forum" for consistency across all documentation.
| - 💬 **[Join our community forum](https://community.kirilov.dev/t/re-watch)** - Get help, share tips, and connect with other users | |
| - 💬 **[Join our Community Forum](https://community.kirilov.dev/t/re-watch)** - Get help, share tips, and connect with other users |
| - 💬 **[Join our Telegram community](https://t.me/+eFftKWGVvSpiZjZk)** - Get help, share tips, and connect with other users | ||
| - 🌐 **[Visit our website](https://rewatch.kirilov.dev/)** - Complete documentation and guides | ||
| - 💬 **[Join our community forum](https://community.kirilov.dev/t/re-watch)** - Get help, share tips, and connect with other users | ||
| - 💬 **[Telegram community](https://t.me/+eFftKWGVvSpiZjZk)** - Real-time chat and support |
There was a problem hiding this comment.
The link text uses lowercase "Telegram community" while other documentation files consistently use title case "Telegram Community" (see docs/index.md:194, docs/detailed_guide.md:374, 428). Consider using "Telegram Community" for consistency across all documentation.
| - 💬 **[Telegram community](https://t.me/+eFftKWGVvSpiZjZk)** - Real-time chat and support | |
| - 💬 **[Telegram Community](https://t.me/+eFftKWGVvSpiZjZk)** - Real-time chat and support |
| - **💬 Join our community**: [Telegram group](https://t.me/+eFftKWGVvSpiZjZk) - Get help from other users | ||
| **A:** | ||
| - **💬 Join our community**: [Community Forum](https://community.kirilov.dev/t/re-watch) - Get help from other users | ||
| - **💬 Telegram group**: [Telegram Chat](https://t.me/+eFftKWGVvSpiZjZk) - Real-time support |
There was a problem hiding this comment.
The link text uses "Telegram group" with the link label "Telegram Chat", while other documentation files consistently use "Telegram Community" (see docs/index.md:194, docs/detailed_guide.md:374, 428). Consider using "Telegram Community" and "Telegram Community" for consistency across all documentation.
| - **💬 Telegram group**: [Telegram Chat](https://t.me/+eFftKWGVvSpiZjZk) - Real-time support | |
| - **💬 Telegram Community**: [Telegram Community](https://t.me/+eFftKWGVvSpiZjZk) - Real-time support |
This pull request updates the documentation and support links across the project to improve clarity and accessibility for users. The main changes focus on promoting the new community forum, enhancing website visibility, and reorganizing support resources for easier navigation.
Documentation and Community Support Improvements:
docs/index.mdandREADME.mdto provide users with complete documentation and updates. [1] [2]docs/index.md,docs/detailed_guide.md, anddocs/faq.mdto feature the new Community Forum, clarify the role of Telegram chat, and reorganize quick links for better user experience. [1] [2] [3] [4] [5]Project Metadata:
repo_urltomkdocs.ymlfor improved navigation between documentation and source code.