The Discourse Docs plugin is a powerful tool that transforms your Discourse forum into a community-powered knowledge base. It provides a dedicated Docs section where users can create, update, and curate documentation. This plugin features a Docs button that allows easy access to this section. Itâs a great way to leverage the collective knowledge of your community and provide a centralized resource for important information.
Filter the list down by tags, search via the search bar, and click on topics to see the first post â all without leaving the context of the knowledge explorer.
For the change to take effect you can either ./launcher rebuild app or, as itâs an environment variable, you can ./launcher destroy app && ./launcher start app to minimise downtime. Thereâs a little more info on that here - Set Environmental Variables
You may also want to change the site display text as well to match. You can search for all instances of âdocsâ from your /admin/customize/site_texts page, but the main ones would be:
I got below error when executing the spec. I didnât change any files. Can I ignore this error?
â discourse git:(main) â LOAD_PLUGINS=1 bundle exec rspec plugins/discourse-docs/spec
Randomized with seed 57815
...................................F
Failures:
1) Discourse Docs | Index topic excerpts when the theme modifier serialize_topic_excerpts is true shows the excerpts
Failure/Error: expect(page).to have_css(".topic-excerpt", text: topic_1.excerpt)
expected to find css ".topic-excerpt" but there were no matches
[Screenshot Image]: /xxxx/discourse/discourse/tmp/capybara/failures_r_spec_example_groups_discourse_docs_index_topic_excerpts_when_the_theme_modifier_serialize_topic_excerpts_is_true_shows_the_excerpts_460.png
~~~~~~~ JS LOGS ~~~~~~~
~~~~~ END JS LOGS ~~~~~
# ./plugins/discourse-docs/spec/system/docs_index_spec.rb:52:in `block (4 levels) in <main>'
# ./spec/rails_helper.rb:469:in `block (2 levels) in <top (required)>'
Finished in 13.16 seconds (files took 2.79 seconds to load)
36 examples, 1 failure
Failed examples:
rspec ./plugins/discourse-docs/spec/system/docs_index_spec.rb:50 # Discourse Docs | Index topic excerpts when the theme modifier serialize_topic_excerpts is true shows the excerpts
Randomized with seed 57815
Sorry @JammyDodger I havenât got a chance to run the Spec these days. I donât focus on the work related to Discourse Docs but other stuff these days. But will let you know when I get any chance.
This plugin is great for having all our document categories all in one place - removing the need for them to also be listed in the Categories list (thanks Discourse Category Hider). However we have noticed an issue:
Within the Docs Plugin/screen you cannot edit existing documents or create new ones - meaning you have to go to the original category, to find the topic/document to edit itâŠmeaning you have to have the document accessible in more than one place.
Is there a way to enable topic/document editing (if the user is in the right User Group) within the Docs plugin?
Hi, I have an issue thatâs real annoying and I do not know why itâs happening.
When i create a doc it goes to the document area and works as its suppose to, however if the document is edited in anyway the docs listing topic document layout switches back to the default discourse topic layout upon click and not show the actual document layout.
Iâve noticed after a few minutes it reverts back to the topic document layout and looks as its supposed to, is there anything that could be causing this?
Note i also use the theme component âTopic Thumbnailsâ and set to docs thumbnail mode âlistâ
Found the issue, apparently if I use Topic List Excerpts or Topic lists Thumbnails theme component the clickable href is for the discourse topic page and not the KB docs?topic=xxx so Iâm being redirected to discourse topics.
Is there a way to maintain the url path on the docs to docs @sam or should reach out to @david ?
Our users recently noticed a minor stylish issue: when the browser has less viewport width, the content of each docs post will overflow, such as in the following screenshot:
I wonder if it would be better to automatically collapse the sidebar, if the viewport is less than ideal; however, even if I collapsed the sidebar, the content would still overflow.
Thanks for the wonderful addon. One question though: is there an option to remove the link from the context hamburger menu? I added it manually in the always-visible section (as we want to use this functionality to showcase longform user-created content like articles etc) and now ended up with it showing up twice:
Both options with lighter background lead to /docs
I revisited the same link on a device with the same viewport width. While there was still overflow before collapsing the sidebar, I found that after collapsing it, there is no overflow, and the display is normal and aesthetically pleasing.