docs: add formatting.md #1359
docs: add formatting.md #1359
Conversation
starlightknown
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-1359--asyncapi-website.netlify.app/ |
|
@alequetzalli I'll still need a review here 😅 |
| --- | ||
| title: Formatting style guide | ||
| description: This style guide explains using correct formats when writing documentation. | ||
| weight: |
There was a problem hiding this comment.
why is the number for the page weight missing? please assign one
| - Use the following Use the following syntax to apply a style. Currently our documenation supports **Remember** `<Remember>`: | ||
| * Surround the text with an opening and closing tag. | ||
| * Use the following syntax to apply a style: | ||
| ` <Remember> | ||
| No need to add a prefix (Remember); the tag automatically provides one | ||
| </Remember>` | ||
|
|
||
| The output: | ||
| <Remember> | ||
| No need to add a prefix (Remember); the tag automatically provides one | ||
| </Remember> |
There was a problem hiding this comment.
This entire section is confusing, and I can't understand it. 😄✌🏽 What are you documenting here? It is not clear that you're explaining that we have a React component for creating a remember card.
Also, why do you have the (remember) in the middle of that sentence in line 20? What do you mean by "no need to add a prefix"? What prefix are you talking about? 👀
Please rewrite this section and think about all the pieces you are trying to educate the reader on ✌🏽
There was a problem hiding this comment.
even after adding tags some people might think they need to write "Remember" inside of tags to make it work. That's what I wanted to address
There was a problem hiding this comment.
Amazing work so far! Your document content is well-structured, nice job! ✨
I have some suggestions to improve the clarity and usefulness of your guide 💜
p.s. yet again, I'm sorry that Style Guide was put in backlog while I interviewed and onboarded the 2023 GSoD folks... I didn't mean to leave you waiting so long 😭 ... my bad, but finally here is your deserved review 😄✌🏽
Co-authored-by: Alejandra Quetzalli <[email protected]>
Co-authored-by: Alejandra Quetzalli <[email protected]>
Co-authored-by: Alejandra Quetzalli <[email protected]>
|
all done |
|
Hey @starlightknown, can I add commits in your PR regarding resolve the build inside Netlify? |
There was a problem hiding this comment.
@starlightknown Kindly make sure that if you add a new section or subsection inside docs, it should always have _section.md file, and the weight inside this file should be minimum as compared to other doc pages inside the same section.
| title: 'Styleguide' | ||
| weight: 10 |
There was a problem hiding this comment.
@alequetzalli kindly look into the weight for this subsection and verify if it's ok with your current structure of the docs.
There was a problem hiding this comment.
Should be ok, we will have Style Guide after the TW Onboarding Guide :)
once it's added in this PR others don't need to add right? or do they? |
Yeah, they don't need to add for |
|
This PR should be raised against the community repo right? @alequetzalli |
|
oh this PR is still here 👀 |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-1359--asyncapi-website.netlify.app/ |
|
Heyo @starlightknown, this looks ready to merge to me, but we actually need to move this to the |
|
@alequetzalli @starlightknown what's the status of this pr? |
|
@sambhavgupta0705 It would be great if you also check yourself, go to the community repo and see if you see a That said, we can also DM @starlightknown in Slack or Twitter, cause I think she will be more responsive there. (Her name is Karuna) I have sent her a DM on Slack just now too. |
|
works @alequetzalli |
|
@alequetzalli @sambhavgupta0705 Just checked myself, the Thanks! |
|
Thanks a bunch, @TRohit20 !! |
|
Ok @TRohit20 |
|
@TRohit20 @sambhavgupta0705 just migrated it, ty |
Description
Related issue(s)
Fixes #1253