This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
Discourse
Discourse is the 100% open source discussion platform built for the next decade of the Internet. Use it as a mailing list, discussion forum, long-form chat room, and more!
- Main Repository: https://github.com/discourse/discourse
- Official announcement for GSoD '19: https://twitter.com/discourse/status/1120370088253591560
Ideas List
1. Restructure docs by mode of writing
Discourse’s documentation follows no specific pattern and readers can easily get lost in the “infinite feed” of navigation-less docs. By restructuring Discourse’s documentation in accordance with the best practices explained in “What nobody tells you about documentation” we want to give readers a sense of completion upon finishing clear-cut segments of documentation.
This work will involve:
- Establishing some ground rules and best practices for writing the four different types of documentation material: tutorial, how-to guide, explanation and reference.
- Re-categorising and tagging several documentation articles
- Splitting up larger articles into smaller series.
- Re-writing certain articles that don’t follow best practices.
- Example task: Fit these three topics into the 4-type pattern: How to create a wiki post, What is a wiki post?, Editing at the same time.
2. Process our #faq-material backlog
We have a big backlog of topics marked as #faq-material, meaning the topic matter at hand is so ubiquitous that it really ought to be elevated to documentation status.
- Clean-write a large amount of backlog topics
- Search for and identify other faq-friendly items.
- Come up with a good structure strategy: These docs are at higher risk of getting outdated so we might want to clearly mark them as "community docs".