Skip to content
New issue

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

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

Already on GitHub? # to your account

Add keywords to the docs #1070

Open
clizbe opened this issue Mar 5, 2025 · 0 comments
Open

Add keywords to the docs #1070

clizbe opened this issue Mar 5, 2025 · 0 comments

Comments

@clizbe
Copy link
Member

clizbe commented Mar 5, 2025

Description

Our strategy of keeping everything general might make it hard for analysts to find the specific concept they're looking for.
What might help is adding keywords/tags to the docs that help when searching.

For instance, in the storage section we might add something with words like "battery," "batteries," etc.
Or once we have MIMO, tag it with "industry," "industrial processes."

Not sure what's a nice/clean way to do this.

Validation and testing

No response

Motivation

If someone is checking if Tulipa can do X, and they just search for X, they might not find it explicitly and think it therefore doesn't exist.

Also, once someone is using Tulipa, it might help them find the way of doing what they want, without knowing the general concept of how to model it (like MIMO or Group Constraints). We can also help a bit with this through tutorials, but I think these tags would help too.

Target audience

Users & potential users

Can you help?

Yes

@clizbe clizbe changed the title Start adding keywords to the docs Add keywords to the docs Mar 5, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant