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

Restore multi-index search capabilities #573

Open
jorgepiloto opened this issue Oct 31, 2024 · 5 comments
Open

Restore multi-index search capabilities #573

jorgepiloto opened this issue Oct 31, 2024 · 5 comments
Labels
docs Issues related to documentation enhancement General improvements to existing features
Milestone

Comments

@jorgepiloto
Copy link
Member

jorgepiloto commented Oct 31, 2024

After migrating to the new [Fuse.js] static search, searching across various search.json files is no longer supported. This has been a request raised by some developers. Thus, lets implement it back before v1.2.

Two options are possible.

  1. Selection of the index when searching. This provides a drop-down for selecting the desired index when searching.
  2. Unifying indices at build time. Desired indices are combined into a single search.json file. When searching, the search will show results from both indices.
@jorgepiloto jorgepiloto added this to the v1.2 milestone Oct 31, 2024
@jorgepiloto jorgepiloto added enhancement General improvements to existing features docs Issues related to documentation labels Oct 31, 2024
@greschd
Copy link
Member

greschd commented Oct 31, 2024

Is there a way to assign weights to the parts of the combined index? When searching within a specific documentation, that module's API reference should have much higher priority than another module's API, for example.
If that's not possible, I think a drop-down (or maybe simpler, a checkbox "search in related packages") is needed.

@MaxJPRey
Copy link
Contributor

I asked for the implementation of a checkbox back in the days when edb and aedt where merged into a single package.
That was really helpful for users.
So if possible, I would also ask for it with our new approach.

@jorgepiloto
Copy link
Member Author

Is there a way to assign weights to the parts of the combined index? When searching within a specific documentation, that module's API reference should have much higher priority than another module's API, for example. If that's not possible, I think a drop-down (or maybe simpler, a checkbox "search in related packages") is needed.

We may be able to do this using the sortFn function and some additional options in the conf.py.

I asked for the implementation of a checkbox back in the days when edb and aedt where merged into a single package. That was really helpful for users. So if possible, I would also ask for it with our new approach.

Regarding this, we will need UI/UX to guide us @Revathyvenugopal162. I am clueless about whether we should use a drop-down, checkboxes, or any others.

@jorgepiloto jorgepiloto modified the milestones: v1.2, v1.3 Oct 31, 2024
@jorgepiloto
Copy link
Member Author

Since we need input from developers and UI/UX, we will postpone this for v1.3.

@germa89
Copy link
Contributor

germa89 commented Oct 31, 2024

PyMAPDL will not use this feature (at least for the moment), so I should probably not give an opinion. However I think any option is very valid, provided that switching to other indexes is clear and evident in the UI in case we go for option 1; or there is a proper highlighting of where the info is coming from in case 2. Of course, performance should be OK for very big indexes like PyAEDT.

Since some projects have tight integration, for instance PyFluent with Pyfluent-visualization, and Pyfluent-parametric; or PyDPF-Post with PyDPF-Core, etc.... You might want to go for the option 2, and make sure to highlight the repository the result is coming from.

PD. This could have been a poll in discussions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues related to documentation enhancement General improvements to existing features
Projects
None yet
Development

No branches or pull requests

4 participants