-
-
Notifications
You must be signed in to change notification settings - Fork 765
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
docs: new cli install fragment #1139
Conversation
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
what if we just merge this one instead? 😄 |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-1139--asyncapi-website.netlify.app/ |
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 only have 2 questions:
- how is this fragment going to be used? Is the assumption that the intro to CLI and reference to GitHub repo are done in a separate section? I'm asking as, after rendering, it looks weird without an intro
- we are missing instructions on how to install on any operating system using NPM (
Using NPM and Node
)
@alequetzalli In general I accept the changes, but let it be accepted by Łukasz, because I see that he sees the problems and knows better what this fragment should have :) |
All EX: If we were adding this fragment to the current Streetlights tutorial, it would look like this...
added! ✅ |
ready for review again @derberg @magicmatatjahu ✨ |
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.
@magicmatatjahu In this PR @alequetzalli uses ###
and ####
but in the preview they look almost identical. Shouldn't h4
have class text-md
instead of text-lg
?
<h3 id="cli-installation" class=" mb-4 mt-6 font-heading antialiased font-medium tracking-heading text-gray-900 text-lg">CLI Installation</h3>
For ToC we have it right 😄 easy to see it is sub section
@derberg Sure, we can change it, but fyi |
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
so ...what are we doing about the header's perceived font size then? leaving as is or...? |
@alequetzalli I think it is more important to visibly distinguish between h3 and h4 than h4 and h5. Because I think h5 is not that often used anyway so please in this PR also make a change in https://github.com/asyncapi/website/blob/master/components/MDX.js#L41
|
@derberg omg YAY, thanks for showing me where to make that style change, I had no idea 😂 Yeah I agree, I'm glad you caught this and noticed the sizing differences, I did not. |
okidoki, I have completed the latest feedback from @derberg ✨✨✨✨ READY FOR REVIEW AGAIN jumps up and down |
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.
Well done 👏🏼
Ready to merge first fragment 🚀 Hail to reusability 🎆
@magicmatatjahu anything from your side?
/rtm |
Take 2 from #1113