Discourse Docs (Documentation Management)

[sam (Sam Saffron)]

	Summary	Discourse Docs provides the ability to find and filter knowledge base topics
	Repository Link	https://github.com/discourse/discourse-docs
	Install Guide	How to install plugins in Discourse

As this is an #official plugin maintained by the Discourse team, #support, #bug, #ux, and #feature requests can be made in the respective categories here on Meta, and tagged with the appropriate plugin tag. Click on a link below to get one started.

 Support  Bug  UX  Feature

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.
   
5. Profit with easier access to knowledge!

Helpful Pairings

Discourse Docs Card Filter Component

This theme component is to be used with the Discourse Docs Plugin. It will allow you to place “Cards” that act as a clickable filter for quicker filter results upon entering the /docs page by your users. [image] The above would be rendered with these settings in the docs plugin: [image] Component Settings You can select custom icons for each category or tag card filter. You can also allow category descriptions to be rendered in the category card filters. [image] …

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

[nolo]

I saw the body element has no specific class on the docs page. Could there be a docs class ?