One of the recent Slack threads was pointing out how other languages such as Clojure and PHP have nice indices with user comments. I am wondering if we could co-opt Discourse for this this purpose. To avoid crowding out other sections, I suggest a documentation section on Discourse.

My current prototype for this starts with trying to crowd source friendly string documentation for Julia: [image] String Documentation Wiki Prototype General Usage Strings Strings in Julia represent a finite sequence of characters. The default String type consi…

[image] mkitti: documentation section on Discourse A section is something? Or do you mean new Category ? I can only see Categories and Tags for organization in discourse. Currently a wiki topic is just a topic like all others, but can be edited by others. A wiki section/category needs a home …

I think a Category is what I am looking for. Specifically, an overall category for Documentation would be good. A sub-category specifically for Base and Standard Library documentation would also be useful.

[image] mkitti: an overall category for Documentation would be good. A sub-category specifically for Base and Standard Library documentation would also be useful. Yes, this. Who can do this? @mbauman ? Some dedicated moderators could do the coordination and cleanups (like perhaps only wiki t…

Yes, it’s quite easy to create new categories — just one button click — but it’s harder to fill, populate, and maintain the topics within them. I’m not terribly convinced about documentation here. In my mind discourse is for discussions, and I’d really want these efforts focused on the docs.juliala…

[image] mbauman: I’d really want these efforts focused on the docs.julialang.org manual itself I support the idea of a documentation category. I think the proposed category is broader than just Julia language documentation. It would also support questions about documentation for user-devel…

I think the original question was a Category for documentation, not about documentation. That is, @mkitti wanted to use the Discourse to solicit/draft new documentation. But as this thread shows, that category will be immediately misunderstood to be for questions about Documenter.jl, etc. – which w…

We could create a Documentation section under tooling Tooling - Julia Programming Language But I agree with Matt, it should be for questions and discussion about the tools themselves and not documentation for packages

I think we need both a category to discuss tooling for documentation, but also a place here on Discourse for documentation itself. Yes, we should feed these efforts back into Github, but I think we should also acknowledge that a Github based process is not for everyone and also does not permit the …

For example these “User contributed notes” are very valuable. [Screenshot_20231016_133349_Chrome]

Could we create a Documentation Category in Discourse?

Meta Discussion

mkitti October 10, 2023, 7:40pm 2

My current prototype for this starts with trying to crowd source friendly string documentation for Julia:

Topic		Replies	Views
Discussion categories Meta Discussion	44	6224	November 24, 2016
FAQ subcategory Meta Discussion proposal	9	2174	November 18, 2016
Can adding "Documentation" category to Julia Discourse be a good idea? Meta Discussion documentation	3	653	June 10, 2020
Link to Julia questions on StackOverflow Meta Discussion	30	5150	June 16, 2017
Welcome to Discourse Meta Discussion	1	11426	October 19, 2016

Could we create a Documentation Category in Discourse?

Related topics