extensions icon indicating copy to clipboard operation
extensions copied to clipboard

[DevDocs]: Support for Search Aliases

Open manishrc opened this issue 1 year ago • 7 comments

Extension

https://www.raycast.com/djpowers/devdocs

Description

DevDocs supports search aliases for popular doc sets like below:

CleanShot 2024-08-20 at 11  27 56@2x

These aliases aren't available in the DevDocs RayCast extension which would improve the need to type longer texts.

CleanShot 2024-08-20 at 11  32 06

Who will benefit from this feature?

No response

Anything else?

Separately, it would be helpful to control which document sets appear, similar to how DevDocs allows disabling some to reduce the noise. For example, I never need Angular documentation and over 650 other doc sets. I'll open a separate issue to discuss this further.

manishrc avatar Aug 20 '24 09:08 manishrc

Thank you for opening this issue!

🔔 @djpowers @pernielsentikaer @j3lte you might want to have a look.

💡 Author and Contributors commands

The author and contributors of djpowers/devdocs can trigger bot actions by commenting:

  • @raycastbot close this issue Closes the issue.
  • @raycastbot close as not planned Closes the issue as not planned.
  • @raycastbot rename this issue to "Awesome new title" Renames the issue.
  • @raycastbot reopen this issue Reopens the issue.
  • @raycastbot assign me Assigns yourself to the issue.
  • @raycastbot good first issue Adds the "Good first issue" label to the issue.
  • @raycastbot keep this issue open Make sure the issue won't go stale and will be kept open by the bot.

raycastbot avatar Aug 20 '24 09:08 raycastbot

For reference, the aliases are listed here: https://devdocs.io/help#aliases

I had briefly looked into this, but the API response for fetching docs (https://devdocs.io/docs/docs.json) doesn't include the alias information. I definitely would want to avoid hard-coding these values so the extension wouldn't need to be updated with any new additions or changes.

It looks like the aliases are defined in the source here: https://github.com/freeCodeCamp/devdocs/blob/main/assets/javascripts/models/entry.js

Ideally these could be added to the API response, but it might be possible to make a call to GitHub to fetch and parse them directly instead.

djpowers avatar Aug 20 '24 12:08 djpowers

@raycastbot assign me

djpowers avatar Sep 29 '24 18:09 djpowers

This issue has been automatically marked as stale because it did not have any recent activity.

It will be closed if no further activity occurs in the next 10 days to keep our backlog clean 😊

raycastbot avatar Nov 18 '24 20:11 raycastbot

Funny timing for the stale bot, an upstream pull request addressing this was just merged a day prior. The change didn't seem to set all of the available aliases, but this feature could now be implemented in such a way that any future aliases would also be surfaced.

djpowers avatar Nov 20 '24 03:11 djpowers

This issue has been automatically marked as stale because it did not have any recent activity.

It will be closed if no further activity occurs in the next 10 days to keep our backlog clean 😊

raycastbot avatar Jan 09 '25 06:01 raycastbot

This can still be worked on, although as mentioned previously, it appears that only a small subsection of aliases are being returned from the API. Hopefully that can be fixed upstream at some point.

djpowers avatar Jan 10 '25 22:01 djpowers