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!

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

51 Likes

A notice of a soon-upcoming change for this plugin. We will be renaming it from Knowledge Explorer to Docs.

https://github.com/discourse/discourse-knowledge-explorer/pull/27

I have a PR ready to go, but wanted to announce here first just in case anyone has built themes/plugins which extend this. This is a breaking change and will cause issues with any extensions built on top of it.

17 Likes

This name change is complete! Please be sure to update your app.yml files to point to the new repository - https://github.com/discourse/discourse-docs.git

13 Likes

You mean like this?

https://meta.discourse.org/docs

6 Likes

How can I contribute to translations? I wanna add German texts.

1 Like

Just to clarufy, do you mean translations to this plugin?

1 Like

Yes, correct! 20 chars

1 Like

Best place to start with Translations is Contribute a translation to Discourse, then this Crowdin project page for this plugin is https://translate.discourse.org/docs

1 Like

Is it possible to keep the navigation container on the Docs page?

1 Like

We did not include this because the Docs view is technically not part of the topic list, and that nav only shows up for the main topic list, nowhere else.

2 Likes

How can docs be made as the default view?

It’s not possible at this time, but you can turn on the plugin setting to get you a top menu item for easy navigation!

2 Likes

How can I hide the docs category in the category view?

Can you clarify a bit more what you’re meaning? Screenshots help a lot!

1 Like

As you can see the “docs” category is still on the left side. How can I “hide/remove” it there because I don’t need it twice, it’s enough to have the link in the menu above.

1 Like