-
Notifications
You must be signed in to change notification settings - Fork 10.3k
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
feat(docs): update docs on Guess.js #8899
Conversation
Hi @dlaub3 -- I checked with other inkteam members, and the proposed title was a bit misleading. This doc should explain what guess.js is, why we'd want to use it, and then link to the gatsby guessjs plugin. Do you mind making these changes? The beginning of the draft looks like it fits, but just modifying the "usage" part to be more about the plugin. |
Can you explain how what you're asking for is different than this https://www.gatsbyjs.org/packages/gatsby-plugin-guess-js/? I'd like to be clear on the goal before I begin. Thanks
|
@amberleyromo @shannonbux
Currently this PR looks a lot like the mentioned example. Did you mix some things up here Amberley or should it be rewritten? @dlaub3 Would you have time to finish this PR once we get feedback on the direction? |
Yes, I'm happy to finish the PR. I just want to be clear on the deliverable first. Thanks. |
Hi @dlaub3 apologies for getting to this only now; we recently implemented a way for me to automatically get mentioned with changes to the docs. I have had the same question myself; why have a doc that essentially repeats the READme file for a plugin? The reason is to increase discoverability of really crucial or prominent plugins. We don't yet have an official list of plugins we want in the docs; they will likely be few in number and mostly focused on official plugins and high-traffic plugins. Eventually we'll also probably want to implement a way of maintaining them easily so they are up-to-date with the READme file. So the bottom line is this file can be very similar to the READme file for gatsbyjs.org/packages/gatsby-plugin-guess-js with this being the goal (same as what @amberleyromo said): introduce guess.js and give a compelling argument for why someone would want to use it, and then link to the gatsby guessjs plugin. So the article can be relatively short. |
Hi @shannonbux, Thanks for the feedback. I've updated the documentation for this page to be a general introduction to Guess.js and then link to the plugin. Let me know what you think. |
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.
Some comments on the text from me.
@shannonbux would need to comment on the title of this doc
Co-Authored-By: dlaub3 <[email protected]>
Yes that's great |
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.
@shannonbux I think this is good to go now. |
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.
LGTM, thank you for adding this! 🎉
Holy buckets, @dlaub3 — we just merged your PR to Gatsby! 💪💜 Gatsby is built by awesome people like you. Let us say “thanks” in two ways:
If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’. Thanks again! |
Looking for feedback on this draft. Thanks.
Issue #8846