README: Rephrase forum into more generic help #20413
Conversation
bergzand
added
Area: doc
bergzand
force-pushed
the
pr/asking_for_help
branch
from
a28860d to
79f16b4
Compare
| You can ask for help on the Forum or on Matrix. Please send bug reports and | ||
| feature requests to our [github issue tracker](https://github.com/RIOT-OS/RIOT/issues) | ||
|
|
||
| - [forum](https://forum.riot-os.org) is the default place to start asking for |
There was a problem hiding this comment.
Forum ... is the default place to ask for help. The Forum provides an archive of prior questions and answers.
There was a problem hiding this comment.
Forum ... is the default place to ask for help. The Forum provides an archive of prior questions and answers.
I don't follow your comment here, could you clarify a bit? Is this a suggestion to rephrase the sentence into the content of your comment?
There was a problem hiding this comment.
yes, this comment was about rephrasing.
- Forum is the default place to ask for help. Our Forum provides an archive of prior questions and answers.
README.md
Outdated
|
|
||
| - [forum](https://forum.riot-os.org) is the default place to start asking for | ||
| help. The search can be used to find older questions and answers. | ||
| - We use [#riot-os:matrix.org](https://matrix.to/#/#riot-os:matrix.org) on the |
There was a problem hiding this comment.
For rather synchronous chats, we use the ...
There was a problem hiding this comment.
IMO the term "synchronous" here is odd. For one, it is technically not correct. Second, the term is too technical here IMO with regard to the diverse target audience that may just wants to start tinkering and has no strong computer science background.
There was a problem hiding this comment.
thanks for this constructive comment.
easy to solve: For chats, we use [...]
README.md
Outdated
| ### How to Ask | ||
|
|
||
| Please include as much detail as you can that is relevant to your question, not | ||
| only "this isn't working". |
README.md
Outdated
| Please include as much detail as you can that is relevant to your question, not | ||
| only "this isn't working". | ||
|
|
||
| 1. What you want to achieve |
|
I wonder if the part you now call should be called 'Communications', with a sub part into 'asking for help'. Since you sum up the communication channels used (forum, matrix chat, GitHub). See this README-template for an overview of communications. The used social media can also be summed up here (mastadon, youtube, ..?) The sub part of communications will then be 'asking for help', stating that the forum is the main channel with the chat for small questions + how to ask. |
|
Can this PR also be labeled 'Community: good first issue'? |
maribu
added
the
Community: good first issue
README.md
Outdated
| Do you have a question, want to discuss a new feature, or just want to present | ||
| your latest project using RIOT? Come over to our [forum] and post to your hearts | ||
| content. | ||
| ## Asking for help |
There was a problem hiding this comment.
| ## Asking for help | |
| ## Community | |
| ### how to get in contact | |
| forum, matrix, webpage | |
| ### Asking for help | |
| You might already find your question answered in our forum or in an Gitub issue. You can search both of them. |
|
@bergzand would you want to give this a final round? |
bergzand
force-pushed
the
pr/asking_for_help
branch
from
8b930d3 to
c4829ca
Compare
bergzand
force-pushed
the
pr/asking_for_help
branch
from
c4829ca to
c324ddf
Compare
|
Rebased! |
bergzand
added
the
CI: ready for build
README: Rephrase forum into more generic help
Contribution description
This PR replaces the section called 'Forum' with a more generic section on 'asking for help'. I couldn't find something similar at first glance in our documentation so it is likely helpful for newcomers to explicitly add this.
Testing procedure
Read the update to the readme and check whether all the links added work.
Issues/PRs references
None