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

Update generated proto reference doc to .mdx #5340

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

danbarr
Copy link
Contributor

@danbarr danbarr commented Jan 22, 2025

Summary

Renames the proto.md generated reference doc to proto.mdx.

Future proofing: The file has inline JSX. Docusaurus currently renders all .md and .mdx with the MDX compiler so this works, but the next major version will change this (.md will be compiled with CommonMark instead; reference).

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Ran make gen to confirm the .mdx file is generated as expected and the docs site builds.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • (N/A) Included tests that validate the fix or feature.
  • (N/A) Checked that related changes are merged.

Has inline JSX, and the next major version of Docusaurus will render
.md and .mdx files differently.
@danbarr danbarr requested a review from a team as a code owner January 22, 2025 23:14
@danbarr danbarr changed the title Update protocol doc generation to .mdx Update generated proto reference doc to .mdx Jan 23, 2025
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.

1 participant