Bug in docs plugin: Pinned topics are not at the top

jrgong · March 7, 2022, 9:03am

Whenever a topic is pinned in a category, it’s not pinned to the top in docs

You can see the behaviour in action here: https://forum.cannabisanbauen.net/docs?tags=01-grundlagen
Is that expected behaviour or a bug?

Discourse version: 2.8.1
Docs plugin version: 0.1

SaraDev · March 21, 2022, 10:01pm

I just tried testing this with Discourse version 2.9.0.beta2 and was unable to reproduce the issue. A pinned topic in a category included in Docs appears to be pinned successfully on the docs page, as expected.

This issue might just be related to Discourse version: 2.8.1, and you could try updating Discourse to resolve this.

Docs plugin version: 0.1

maiki · April 5, 2022, 9:08pm

I can reproduce this with 2.9.0.beta3. The docs index appears to default to recent activity, and doesn’t sort by pinned status; it does, however, show the correct pinned status by icon.

I pinned the first doc I created, hence it is the “oldest”:

I updated the pinned doc, making it the more recent activity:

And added a new doc, which then becomes the most recent:

I changed the pinned status on the topic (meaning the discussion, the “docs view” does not show the pinned status).

And it updated on the docs index:

Notes:

I tried a category and global pin: same results
Any activity bumps the doc in the index: the more recently discussed topics will be at the top

sam · April 28, 2022, 2:21am

Sadly this is quite a major change to both core and the plugin.

Tough we use TopicQuery to get the lists of topics, we handle all ordering outside of TopicQuery in:

github.com/discourse/discourse-docs

lib/docs/query.rb

main


      
            SiteSetting.docs_categories.split("|")
          end
          
          def self.tags
            SiteSetting.docs_tags.split("|")
          end
          
          def list
            # query for topics matching selected categories & tags
            opts = { no_definitions: true, limit: false }
            tq = TopicQuery.new(@guardian.user, opts)
            results = tq.list_docs_topics
            results =
              results.left_outer_joins(SiteSetting.show_tags_by_group ? { tags: :tag_groups } : :tags)
            results = results.references(:categories)
            results =
              results.where("topics.category_id IN (?)", Query.categories).or(
                results.where("tags.name IN (?)", Query.tags),
              )
          
            # filter results by selected tags

To complete this we would probably need to move it so “core” handles ordering here instead of the plugin doing its own thing. It is a very complex change.

On the upside we can potentially remove a bunch of code from the plugin.

Sorry but I got to put this bug on the backburner for now.

jrgong · March 25, 2024, 11:43am

it seems, this issue still persists? We just tested on 3.2 and latest docs plugin version. Pinned topics are not displayed at the top in docs.

jrgong · June 3, 2024, 7:34pm

Has anyone been able to find a solution or workaround?

Topic		Replies	Views
Make pinned topics appear before unpinned Support	2	615	January 11, 2019
Discourse Docs Plugin – Topics Not Updating in Docs Page Support docs	6	411	April 16, 2025
How do I set the order of pinned topics Feature	27	6397	August 25, 2021
Pinning topics in set order Feature	15	4105	November 25, 2021
Where are the pinned topics? Site feedback pinned-topics	5	317	September 25, 2025

Bug in docs plugin: Pinned topics are not at the top

AI-generated summary

Related topics