-
Notifications
You must be signed in to change notification settings - Fork 19
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
Martinh/faq #93
Conversation
There was a problem hiding this 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?
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
I added the Queries FAQs to this new page and deleted the Queries FAQ content from the Build section. |
There was a problem hiding this 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.
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
There was a problem hiding this 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
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Ilaria <[email protected]>
There was a problem hiding this 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!
There was a problem hiding this 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! ✨
Co-authored-by: Erin Shaben <[email protected]>
Co-authored-by: Erin Shaben <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Beautiful! 🚀
Description
Created FAQs page under the Learning section based on most common Discord questions.
Checklist
wormhole-mkdocs
repo