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

Implement search React documentation command #348 #349

Merged
merged 4 commits into from
Feb 6, 2024

Conversation

kristersd
Copy link
Contributor

@kristersd kristersd commented Jan 18, 2024

Implemented additional commands !docs and !react-docs to search React documentation. The output embed will contain a link to documentation and short intro segment from their page.

Extra:

  • Fixed MDN icon_url not being found.

reactibot

Copy link

what-the-diff bot commented Jan 18, 2024

PR Summary

  • Addition of new import statements to commands.ts
    Several new import statements were added to the commands.ts code. These are the building blocks needed for the upcoming functionalities.

  • Addition of a New Object to commands.ts
    A new object has been added to the commands.ts file. This object brings fresh data and enhances functionality of our existing application.

  • Introduction of a New Function in commands.ts
    The new function, generateReactDocsErrorEmbeds, has been added to commands.ts. This function will increase the robustness of our app by handling errors related to React documentation in a more structured manner.

  • Creation of a New File 'react-docs.ts'
    A new auxiliary file src/helpers/react-docs.ts has been added. It will help in obtaining and managing React documentation, which will result in a more user-friendly and informative application.

@ghost
Copy link

ghost commented Jan 18, 2024

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

@kristersd kristersd changed the title [draft] Implement search React documentation command #348 Implement search React documentation command #348 Jan 18, 2024
Copy link
Member

@vcarl vcarl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry it's taken me a while to come back to this!! I think this is a solid effort and a valuable addition, in trying to use it I'm finding it awkward — pretty heavily reliant on knowing what terms are available, and the cooldown makes trial-and-error tough. I'm down to merge this though and iterate, merge whenever you're comfortable 👍

(Failing check is expected, non-org contributions fail cuz of a permissions bug that hasn't been worth chasing down yet)

@vcarl
Copy link
Member

vcarl commented Feb 5, 2024

This is maybe a candidate for swapping out to a slash command + autocomplete, I think there's prior art for that in #241

@kristersd kristersd merged commit c821515 into reactiflux:main Feb 6, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants