search

chipzoller / hugo-clarity

A theme for Hugo based on VMware Clarity
Other
571 stars 263 forks source link

'Featured' tag and 'featured' param in example might be confusing #356

Open rootwork opened 2 years ago

rootwork commented 2 years ago

In testing #353 I noticed that in our exampleSite we have a featured post ("Markdown Syntax Guide") with both of these things set:

Being able to feature posts is a good...feature! But the functionality to do so only operates on the featured param itself (the first item above), not the tag.

This seems like it could be confusing to users. Would it be worth doing one of these?

  1. removing the "featured" tag from the example featured post, or
  2. automatically adding a "featured" tag whenever the featured param is set to true, or
  3. having the check for which posts to feature look at both the param and the tags; either would enable a post to be featured

Any opinions?

LukeHong commented 2 years ago

I think it might be better to remove the tag from the current one as the first option, then add a new post about featured post(and maybe pinned post) to demonstrate how it works.