# Discourse Docs **URL:** https://meta.discourse.org/t/discourse-docs/130172 **Category:** Plugin **Tags:** official, docs, end-of-life **Created:** [October 3, 2019, 7:10pm UTC](https://meta.discourse.org/t/discourse-docs/130172 "2019-10-03T19:10:37Z") **Posts on this page:** 1 **Showing post:** 1
### Author: ![Discourse](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/discourse/32/148734_2.png) [@Discourse](https://meta.discourse.org/u/Discourse) #### Post date: [October 3, 2019, 7:10pm UTC](https://meta.discourse.org/t/discourse-docs/130172/1 "2019-10-03T19:10:37Z")
> ⚠ This plugin is being retired in favour of the experimental [Doc Categories plugin](https://meta.discourse.org/t/discourse-doc-categories/322376). We will still support Docs until the new plugin is no longer considered experimental. | | | | | --- | --- | --- | | :discourse2: | **Summary** | **Discourse Docs** provides the ability to find and filter knowledge base topics | | 🛠 | **Repository Link** | [https://github.com/discourse/discourse-docs](https://github.com/discourse/discourse-docs) | | 📖 | **Install Guide** | [How to install plugins in Discourse](https://meta.discourse.org/t/install-plugins-in-discourse/19157) | > [@](#): > > :discourse2: As this is an #official plugin maintained by the Discourse team, #Support, #Contribute > Bug, #Contribute > UX, and #Contribute > 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**](https://meta.discourse.org/new-topic?category_id=6&body=%3E%20Before%20asking,%20did%20you%20search%20first%3F%20Press%20%F0%9F%94%8D%20at%20the%20upper%20right%20to%20search.&tags=docs "Ask for support on configuring and using Discourse Docs") [🐛  **Bug**](https://meta.discourse.org/new-topic?category_id=1&tags=docs "A bug report means something is broken, preventing normal/typical use of the plugin") [👀  **UX**](https://meta.discourse.org/new-topic?category_id=9&tags=docs "Discussion about the user interface of Discourse Docs, and how features are presented (including language and UI elements)") [💡  **Feature**](https://meta.discourse.org/new-topic?category_id=2&tags=docs "Discussion about how existing Discourse Docs features can be improved or enhanced, and how proposed new features could work") ### Features 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. In essence, Docs allows for easier surfacing of knowledge-base style topics across a defined set of categories and/or tags. ![docs page](https://global.discourse-cdn.com/meta/original/3X/b/f/bf89c5aad3835d1b4da4b5cb61c40a4e9573b7d5.png) 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. ![filter topics](https://global.discourse-cdn.com/meta/original/3X/1/4/14baef7c76d52ca76f2dd6ce125fddaa1b39564c.png) ![search topics](https://global.discourse-cdn.com/meta/original/3X/c/1/c192ebcaf525714d81ef65471cca84617c5572ef.png) Need to find a knowledge base topic from somewhere else in Discourse? Use the new search helper: `in:kb`. ![in:kb](https://global.discourse-cdn.com/meta/original/3X/1/b/1b2cd1522b6dd11a041579a36a9e817e7f41a85d.png) ### Configuration 1. Enable the plugin by turning on the `docs enabled` setting. 2. Add categories and tags to the `docs categories` and `docs tags` settings. 3. Find the Docs link in the navigation menu. ![Screen Shot 2021-03-01 at 12.49.14 PM](https://global.discourse-cdn.com/meta/original/3X/a/e/ae2abc6f1ec75e18029b699c9e06f3d199b775ca.png) 1. Profit with easier access to knowledge! ### Settings | Name | Description | | --- | --- | | docs enabled | Enable the Docs Plugin | | docs categories | A list of category slugs to include in docs | | show tags by group | Organize tags using Tag Groups. Create groups to categorize related tags. | | docs tag groups | The Tag Groups used to show tags by group | | docs tags | A list of tags to include in docs | | docs add solved filter | Adds a filter for solved topics – requires Discourse Solved to be installed and enabled | | docs add to top menu | Adds a link to the top menu to navigate to the Docs view | | docs add search menu tip | Adds the tip “in:docs” to the search menu random tips | ### Helpful Pairings > [@Discourse Docs Card Filter](https://meta.discourse.org/t/discourse-docs-card-filter-component/187947): > > discourse2Summary Discourse Docs Card Filter is to be used with the [Discourse Docs Plugin](https://github.com/discourse/discourse-docs) and allows you to place “Cards” that act as a clickable filter for quicker filter results upon entering the /docs page by your users.eyeglassesPreview [Preview on Discourse Theme Creator](https://discourse.theme-creator.io/theme/Discourse/docs-card-filter)hammer_and_wrenchRepository Link [https://github.com/discourse/discourse-docs-card-filter](https://github.com/discourse/discourse-docs-card-filter)open_bookNew to Discourse Themes? [Beginner’s guide to using Discourse Themes](https://meta.discourse.org/t/beginners-guide-to-using-discourse-themes/91966) Install this theme comp… ### Renaming the `/docs` path If you have access to your server you can change the path of your `/docs` link by adding a `DISCOURSE_DOCS_PATH:` environment variable to your `app.yml`: ![discourse_docs_path](https://global.discourse-cdn.com/meta/original/4X/d/b/3/db3182ef270516f69f58df114549a64cf02e2e3e.png) 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](https://meta.discourse.org/t/set-environmental-variables/270832) 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: - js.docs.title - js.sidebar.docs\_link\_text ![cake recipe display text](https://global.discourse-cdn.com/meta/original/4X/9/3/4/93419f9c92e460c3cde66b274243c32ab6d33eba.png) > :discourse2: **Hosted by us?** Renaming the `/docs` path is only available on our Enterprise plan. Please contact us if you’d like to learn more. ### Development History The Docs plugin was a continuation from the [Knowledge Explorer Theme Component](https://meta.discourse.org/t/knowledge-base-theme-component/121898). > Last edited by @HAWK 2026-07-06T22:06:30Z > > Last checked by @hugh 2024-08-27T04:23:36Z > > > **Check document** > > > > Perform check on document: --- _[View the full topic](https://meta.discourse.org/t/discourse-docs/130172)._