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

48 Likes

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

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.

16 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

12 Likes

You mean like this?

https://meta.discourse.org/docs

6 Likes

Would the team consider adding the navigation container to Docs?

I could be switching back and forth from Top to Categories to Latest, but once I hit Docs, there is no navigational UI to allow users to continue navigating between the different sections

1 Like

You can easily do it yourself, just install the theme component “custom top navigation links” by @Johani

Thank you Per. I already have Johani’s excellent theme component installed. It works great and shows up across different categories. However, it is not applying to Docs.

Would there be a setting or CSS tweak that can effect this to Docs?

The reason it doesn’t exist is we’re following patterns from the rest of the app. The top nav doesn’t show up anywhere else other than on the topic list, as it’s designed to be a filter. We’ve just appended a Docs links there to make it easier to access.

However, there is a plugin outlet above the Docs search bar someone could whip up a theme component and add a menu up there if needed.

2 Likes