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

Refactor: Use multi-index search for meili #224

Open
almostSouji opened this issue Oct 15, 2024 · 2 comments
Open

Refactor: Use multi-index search for meili #224

almostSouji opened this issue Oct 15, 2024 · 2 comments
Labels
💡 idea New feature or request

Comments

@almostSouji
Copy link
Member

Can potentially avoid having multiple split commands to query docs in favor of a global search. (Potential issues with key length limited by custom id, maybe re-consider command setup)

@almostSouji
Copy link
Member Author

Unsure how to handle versions, the website seems to know which sub packages need to be queried at which version
So the version dropdown would then follow the discord.js version

Also arises the question of if we need sub commands at all or if this can be a one and done solution
Imo this depends on how the version dropdown may work, we can declare specific versions of subpackages as unsupported (people may always use the website to link to directly), as the general use case for the docs app seems to be the main package in the currently supported version range with occasional expanding search into subpackages relevant to the same range.

image

image

@almostSouji
Copy link
Member Author

From the api.json, it has a dependencies: field listing the packages and their versions. I would have to look up where that is in the split json though. I believe it‘s a seperate dependencies.json or so https://github.com/discordjs/discord.js/blob/48a9c665dedf9f5085a7992df3a87de3bca2301a/packages/scripts/src/generateSplitDocumentation.ts#L1023 it’s in .dependencies.api.json

@almostSouji almostSouji added the 💡 idea New feature or request label Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 idea New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant