docs: code-examples #1349
docs: code-examples #1349
Conversation
sambhavgupta0705
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 settings. |
|
PTAL @alequetzalli |
|
|
||
| Code examples which you add must be simple enough to understand and with good details to do something interesting and useful. | ||
|
|
||
| You need to add pratical code examples which adheres to industry standards as users will copy the sample code and run it in production.Be sure to include any warnings thriugh comments which might occur during code run. |
There was a problem hiding this comment.
| You need to add pratical code examples which adheres to industry standards as users will copy the sample code and run it in production.Be sure to include any warnings thriugh comments which might occur during code run. | |
| You need to add practical code examples which adhere to industry standards as users will copy the sample code and run it in production. Be sure to include any warnings through comments which might occur during the code run. |
There was a problem hiding this comment.
please run a complete Grammarly check here, there are spelling mistakes too
|
|
||
| Put the characters for the open-brace ("") on the same line as the sentence that opens the block. | ||
|
|
||
| In all code samples, the indentation should be two spaces per tab.] |
There was a problem hiding this comment.
| In all code samples, the indentation should be two spaces per tab.] | |
| In all code samples, the indentation should be two spaces per tab. |
| After adding comments ,start writing code from the next line. | ||
| ## General | ||
|
|
||
| Make no assumptions about the readers' familiarity with any libraries, frameworks, preprocessors, or other non-native features. |
There was a problem hiding this comment.
| Make no assumptions about the readers' familiarity with any libraries, frameworks, preprocessors, or other non-native features. | |
| Make no assumptions about the reader's familiarity with any libraries, frameworks, preprocessors, or other non-native features. |
| Write your code to be as clean and understandable as possible | ||
|
|
||
| Add links of the library or documentation for better understanding. | ||
|
|
| Add proper spacing between code blocks | ||
|
|
||
| After adding comments ,start writing code from the next line. | ||
| ## General |
There was a problem hiding this comment.
| ## General | |
| ### General |
be consistent with the headings. # for main, ## & ### for subheadings and should be mainly used.
| Code examples which you add must be simple enough to understand and with good details to do something interesting and useful. | ||
|
|
||
| You need to add pratical code examples which adheres to industry standards as users will copy the sample code and run it in production.Be sure to include any warnings thriugh comments which might occur during code run. | ||
| Make it clear if it is a snippet and not a full example.Provide information about any packages or dependencies which would be required to run the sample code. |
There was a problem hiding this comment.
| Make it clear if it is a snippet and not a full example.Provide information about any packages or dependencies which would be required to run the sample code. | |
| Make it clear if it is a snippet and not a complete example. Provide information about any packages or dependencies required to run the sample code. |
Co-authored-by: Karuna Tata <74637789+starlightknown@users.noreply.github.com>
Co-authored-by: Karuna Tata <74637789+starlightknown@users.noreply.github.com>
Co-authored-by: Karuna Tata <74637789+starlightknown@users.noreply.github.com>
Co-authored-by: Karuna Tata <74637789+starlightknown@users.noreply.github.com>
|
@starlightknown can you please tell the correct file location where I need to place this. |
Co-authored-by: Karuna Tata <74637789+starlightknown@users.noreply.github.com>
Co-authored-by: Karuna Tata <74637789+starlightknown@users.noreply.github.com>
I'm not sure either as each contributor placed these files in different places, Alejandra might be able to help. I slacked but might be OOO. We should wait |
Okay ,and can you tell me how to resolve this lighthouse error |
|
could you try changing the path? pages/community/styleguide/accessibility.md |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-1349--asyncapi-website.netlify.app/ |
sambhavgupta0705
requested review from
starlightknown
and removed request for
starlightknown
|
Hey @starlightknown made all the changes.Let me know if there are any more things to improve here. |
|
@alequetzalli PTAL :) |
Co-authored-by: Alejandra Quetzalli <alejandra.olvera.novack@gmail.com>
Co-authored-by: Alejandra Quetzalli <alejandra.olvera.novack@gmail.com>
Co-authored-by: Alejandra Quetzalli <alejandra.olvera.novack@gmail.com>
Co-authored-by: Alejandra Quetzalli <alejandra.olvera.novack@gmail.com>
Co-authored-by: Alejandra Quetzalli <alejandra.olvera.novack@gmail.com>
Co-authored-by: Alejandra Quetzalli <alejandra.olvera.novack@gmail.com>
Co-authored-by: Alejandra Quetzalli <alejandra.olvera.novack@gmail.com>
Co-authored-by: Alejandra Quetzalli <alejandra.olvera.novack@gmail.com>
Co-authored-by: Alejandra Quetzalli <alejandra.olvera.novack@gmail.com>
Co-authored-by: Alejandra Quetzalli <alejandra.olvera.novack@gmail.com>
quetzalliwrites
added
📑 docs
area/docs
| --- | ||
| title: Code examples | ||
| weight: 20 | ||
| --- |
There was a problem hiding this comment.
Please add a description to the meta data section. ✌🏽
There was a problem hiding this comment.
Added the description 👍🏻
|
|
||
|
|
There was a problem hiding this comment.
Please remove the extra spaces of lines 5-6, we don't want huge empty spots in our docs' formatting/spacing 😂✌🏽
|
pingy pongo @sambhavgupta0705 😄 You still have some feedback left to address, please look carefully again ✨ |
|
Why did you close this PR @sambhavgupta0705? 😸 |
|
Lol,deleted that fork because of merge conflicts. |
Description
This PR adds documentation for how to add code examples.
Related issue(s)
Resolves #1245