Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
rootwork opened this issue Jul 26, 2022 · 1 comment
Open

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

rootwork opened this issue Jul 26, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@rootwork
Copy link
Contributor

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

  • featured = true
  • tags = [ ... "featured" ]

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?

@rootwork rootwork added the enhancement New feature or request label Jul 26, 2022
@LukeHong
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants