Skip to content

Commit 8013447

Browse files
committed
Improve Community Channel Discoverability in README #7310
1 parent 48afa53 commit 8013447

2 files changed

Lines changed: 23 additions & 3 deletions

File tree

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Ticket: Improve Community Channel Discoverability in README
2+
3+
GH ticket id: #7310
4+
5+
**Assignee:** Gemini
6+
**Status:** Done
7+
8+
## Description
9+
The current `README.md` creates confusion about the best place to seek community support. The Discord badge is prominent, but the more active Slack channel is buried at the bottom. Furthermore, we want to strategically guide users toward Discord for its persistent history, which is better for long-term community knowledge.
10+
11+
## Acceptance Criteria
12+
1. Create a new, prominent "Community & Support" section in `README.md`, placed directly after the introduction/demo videos.
13+
2. In this new section, list Discord first and label it as the "Recommended" channel, explaining that its history is permanent and searchable.
14+
3. List Slack second, describing it as an option for real-time chat and explicitly mentioning that its message history is temporary.
15+
4. Remove the old, redundant "Join the Community" section from the bottom of the `README.md`.

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ By leveraging a **pioneering Off-Main-Thread (OMT) architecture**, Neo.mjs ensur
2929
</p>
3030

3131
</br></br>
32+
## 🤝 Community & Support
33+
34+
Have a question or want to connect with the community? We have two channels to help you out.
35+
36+
* **[💬 Discord (Recommended for Questions & History)](https://discord.gg/6p8paPq):** Our primary community hub. All conversations are permanently archived and searchable, making it the best place to ask questions and find past answers.
37+
* **[⚡️ Slack (For Real-Time Chat)](https://join.slack.com/t/neomjs/shared_invite/zt-6c50ueeu-3E1~M4T9xkNnb~M_prEEOA):** Perfect for quick, real-time conversations. Please note that the free version's history is temporary (messages are deleted after 90 days).
38+
3239
## 🚀 Why Choose Neo.mjs? Solving the Toughest UI Challenges
3340
Traditional single-threaded frontend frameworks often struggle with performance bottlenecks and UI freezes, especially for
3441
large-scale, data-intensive, or real-time applications. Neo.mjs offers a fundamentally different solution, designed for
@@ -240,9 +247,7 @@ Next steps:
240247
* :blue_book: All Blog Posts are listed here: [Neo.mjs Blog](https://neomjs.com/dist/production/apps/portal/#/blog)
241248

242249
</br></br>
243-
## :handshake: Join the Community
244-
245-
:speech_balloon: Have questions? Join our [Slack channel](https://join.slack.com/t/neomjs/shared_invite/zt-6c50ueeu-3E1~M4T9xkNnb~M_prEEOA) and connect with other developers.
250+
## :handshake: How to Contribute
246251

247252
:hammer_and_wrench: Want to contribute? Check out our [Contributing Guide](https://github.com/neomjs/neo/blob/dev/CONTRIBUTING.md).
248253

0 commit comments

Comments
 (0)