Skip to content
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: highlight <code/>, correct typos and servers.md <CodeBlock/> #2523

Closed

Conversation

nikhilkalburgi
Copy link
Contributor

Description

  • Enhancement: The code tags should appear bold everywhere in the docs
  • Typo: Found some typos in tutorials + missing of proper redirects.
  • Fix: The Codeblock in servers.md in not hightlighted correctly.

Related issue(s)
Fixes #2522

…lock highlight in tutorials

__Enhancement:__ The code tags should appear bold everywhere in the docs
__Typo:__ Found some typos in tutorials + missing of proper redirects.
__Fix:__ The Codeblock in servers.md in not hightlighted correctly.

Signed-off-by: nikhilkalburgi <nikhilkalburgi19@gmail.com>
Copy link

netlify bot commented Jan 3, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 66f283e
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/65950cd15fae9b00086b6cd8
😎 Deploy Preview https://deploy-preview-2523--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@asyncapi-bot
Copy link
Contributor

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 45
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-2523--asyncapi-website.netlify.app/

@@ -340,4 +340,8 @@ abbr[title] {

.meeting-card:hover > div:nth-child(2) > p {
color: white;
}

code{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why have you made font-weight bold here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @akshatnema,

The <code/> content are not highlighted well and the users cannot identify the keywords used in the docs.
image

@quetzalliwrites
Copy link
Member

quetzalliwrites commented Mar 25, 2024

  1. The spelling typos mentioned in this PR are already fixed LIVE.
  2. The requested hard coding of <bold> HTML tags is not within best practices, nor does it follow our brand guidelines.

Closing this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs Bug 🐞 report]: highlight code tags, correct typos and adjust servers codeblock highlight in tutorials
4 participants