Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Jun 10, 2025

Documentation changes

Documents all meta features available with new code blocks.

Closes


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Copy link
Contributor

@dks333 dks333 left a comment

Choose a reason for hiding this comment

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

we have added support for all languages listed here in shiki docs, we should remove our current list and just add a reference to this link

@ethanpalm ethanpalm marked this pull request as ready for review June 11, 2025 18:11
Copy link
Member

Choose a reason for hiding this comment

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

Recommend adding something to note that for all features, they need to have language set first. It doesn't work when it's like this directly

```title="Title"
Code
```

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Great point. I made all the options H3s under an H2 for code block options to introduce this information and make it more clear that these options only apply to code blocks. It should be apparent that you can't style inline code, but this makes it more direct.

@ethanpalm ethanpalm merged commit a8396a5 into main Jun 11, 2025
4 checks passed
@ethanpalm ethanpalm deleted the codeblock-v3-docs branch June 11, 2025 20:44
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.

3 participants