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

Martinh/faq #93

Merged
merged 37 commits into from
Oct 23, 2024
Merged

Martinh/faq #93

merged 37 commits into from
Oct 23, 2024

Conversation

martin0995
Copy link
Collaborator

Description

Created FAQs page under the Learning section based on most common Discord questions.

Checklist

  • Required - I have added a label to this PR 🏷️
  • Required - I have run my changes through Grammarly
  • If pages have been moved, I have created redirects in the wormhole-mkdocs repo

@martin0995 martin0995 added the A0 - New Content Pull request contains new content pages label Sep 19, 2024
Copy link
Collaborator

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Nice job! Since this is a FAQ page for a variety of tools, perhaps we should move the Queries FAQ content to this page - wdyt?

@martin0995
Copy link
Collaborator Author

I added the Queries FAQs to this new page and deleted the Queries FAQ content from the Build section.

@martin0995 martin0995 requested a review from eshaben September 23, 2024 15:18
Copy link
Collaborator

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Noticed a few more things after looking at this with fresh eyes 👀

I think we might need to revisit the placement of this page. Most of these are questions users would run into when developing with Wormhole, as opposed to when they're learning about the basics and such.

@martin0995 martin0995 requested a review from eshaben October 1, 2024 15:19
@martin0995 martin0995 changed the title Martinh/learn faq Martinh/faq Oct 14, 2024
Copy link
Collaborator

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

I'm not sold on having an FAQ directly under Build. I think the reason behind splitting the FAQ up into specific directories is that so they're easier to find and are more fruitful for users focusing on a specific topic. It seems like having it directly under Build might not be the best solution, unless the questions are generic. Otherwise, we should consider why the user might be asking these questions and try to put the FAQ pages near related content or even as sections within specific content, if that makes more sense.

If you think the questions are generic enough to be put under build, then you'll have to get an icon for FAQ for the dropdown menus from the designers and we'll have to publish this PR and the mkdocs PR at the same time.

Requesting @ilariae and @evgeniko reviews on this for additional opinions

@eshaben eshaben requested review from ilariae and evgeniko October 17, 2024 02:19
@martin0995 martin0995 requested a review from eshaben October 21, 2024 11:05
Copy link
Collaborator

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Nice! Just need to update the index pages and this should be good to go!

@martin0995 martin0995 requested a review from eshaben October 22, 2024 16:17
Copy link
Collaborator

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Sorry just one tiny nit 😬 but looks good! ✨

@martin0995 martin0995 requested a review from eshaben October 23, 2024 10:13
Copy link
Collaborator

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Beautiful! 🚀

@eshaben eshaben merged commit dcc06a5 into main Oct 23, 2024
1 check passed
@eshaben eshaben deleted the martinh/learn-faq branch October 23, 2024 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A0 - New Content Pull request contains new content pages
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants