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

Allow tags in generated-index sidebar item #9841

Closed
2 tasks done
Dr-Electron opened this issue Feb 9, 2024 · 4 comments
Closed
2 tasks done

Allow tags in generated-index sidebar item #9841

Dr-Electron opened this issue Feb 9, 2024 · 4 comments
Labels
closed: wontfix A fix will bring significant overhead, or is out of scope (for feature requests) feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.

Comments

@Dr-Electron
Copy link
Contributor

Have you read the Contributing Guidelines on issues?

Description

As tags are more useful then keywords it would make sense to allow them too in the generated-index option

Has this been requested on Canny?

No response

Motivation

Tags are more useful but not supported. Keywords are. Would be nice to have at least both

API design

No response

Have you tried building it?

No response

Self-service

  • I'd be willing to contribute this feature to Docusaurus myself.
@Dr-Electron Dr-Electron added feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. status: needs triage This issue has not been triaged by maintainers labels Feb 9, 2024
@Josh-Cena
Copy link
Collaborator

Josh-Cena commented Feb 15, 2024

The "keywords" are just SEO meta like "image" and "description" so they are very trivial to add (every single page supports these features). "Tags" are much more complex to build because they require treating these generated indices as actual doc pages. I can see the use case for tags, but the two features you mentioned are unrelated.

@slorber
Copy link
Collaborator

slorber commented Feb 15, 2024

Yes tags and keywords are totally unrelated. And adding tags to category generated index would not be so easy, for little ROI IMHO.


Considering you can link a category to an actual doc, and render a similar UI through the DocCardList component:
https://docusaurus.io/docs/sidebar/items#embedding-generated-index-in-doc-page

Wouldn't this be a good enough workaround to just link the category to a doc, and put tags on that doc?

This would lead to a similar result IMHO.

@slorber slorber removed the status: needs triage This issue has not been triaged by maintainers label Feb 15, 2024
@Dr-Electron
Copy link
Contributor Author

I know that the changes are not trivial. I was just asking as a past discussion on the keyword lead to keywords basically being useless and so we replaced them everywhere to tags as that was the plan from the beginning anyway. We just used keyword in the beginning as we thought we could get both: indexing of pages and SEO. But as this was not the case we switched now.

But @slorber suggestion should work completely fine. I didn't think about it. Although for completeness you might want to think about supporting tags. For my use case this issue can be closed tho if you want. I will leave the decision up to you. Thanks for your awesome work ❤️

@slorber
Copy link
Collaborator

slorber commented Feb 18, 2024

Thanks

To me this workaround is good enough so I'm going to close for now. We'll reopen if someone comes up with a good reason for not using that workaround.

@slorber slorber closed this as not planned Won't fix, can't repro, duplicate, stale Feb 18, 2024
@slorber slorber added the closed: wontfix A fix will bring significant overhead, or is out of scope (for feature requests) label Feb 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closed: wontfix A fix will bring significant overhead, or is out of scope (for feature requests) feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.
Projects
None yet
Development

No branches or pull requests

3 participants