Discourse-docs: Documentation Management Plugin

Summary: Find and filter knowledge base topics

:link: GitHub: https://github.com/discourse/discourse-docs
:arrow_right: Install: Follow the plugin installation guide.

Features

The Docs plugin is a continuation of development on the Knowledge Explorer Theme Component. You can see it in action at https://meta.discourse.org/docs.

In essence, Docs allows for easier surfacing of knowledge-base style topics across a defined set of categories and/or tags.

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.

Need to find a knowledge base topic from somewhere else in Discourse? Use the new search helper: in:kb.

Configuration

  1. Install the plugin following these instructions.
  2. Enable the plugin by turning on the docs enabled setting.
  3. Add categories and tags to the docs categories and docs tags settings.
  4. Find the Docs link in the hamburger menu.
    Screen Shot 2021-03-01 at 12.49.14 PM
  5. Profit with easier access to knowledge!

Helpful Pairings

CHANGELOG

  • 2021-01-18T06:00:00Z Rename to discourse-docs
  • 2021-01-13T06:00:00Z Add topic title and category to browser title
  • 2020-10-01T05:00:00Z Added onebox support

TODO

64 Likes

Noticed a small bug in Docs: Anchor links to specific headlines seam not to work.
For example open this one:

https://meta.discourse.org/docs?ascending=false&category=10&topic=152002#first-steps-3

Also a question that has been probably asked in the past: Any way to change the slug /docs to something different?

4 Likes

We recently installed your “Docs” plugin, but then we noticed, that despite our discourse being in German, the “Docs” link still showed the English “Docs”. Could you implement i18n/l10n or just a text input setting where the administrators can choose the label of the link to their liking?

1 Like

You have to translate by yourself using tools of backend, as normally have to do.

Hamburger → Admin → Customise → Text → searching Docs — you are looking for js.docs.title

4 Likes

Ah, thank you. Forgot to look for that :man_facepalming:

1 Like