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: remove html comments in protoc docs #1435

Closed
wants to merge 1 commit into from

Conversation

constantoine
Copy link
Contributor

@constantoine constantoine commented Sep 22, 2023

Remove HTML comments in the middle of the MarkDown template because docusaurus rejects them.

Related to #1431.

Checklist

  • I have read the contributing guidelines.
  • I have referenced an issue containing the design document if my change
    introduces a new feature.
  • I am following the
    contributing code guidelines.
  • I have read the security policy.
  • I confirm that this pull request does not address a security
    vulnerability. If this pull request addresses a security vulnerability, I
    confirm that I got the approval (please contact
    [email protected]) from the maintainers to push
    the changes.
  • I have added tests that prove my fix is effective or that my feature
    works.
  • I have added or changed the documentation.

Further Comments

@constantoine
Copy link
Contributor Author

Hi again, I did this PR because apparently during the docs build, docusaurus crashed, see herepipeline

@vinckr
Copy link
Member

vinckr commented Sep 22, 2023

Hey @constantoine

I already took a look as well woops.
I think we can leave the comments, it works like I did it here:
#1436

@constantoine
Copy link
Contributor Author

Hi @vinckr

Woops. No problem, your solution seems better anyway because it also fix auto-closing tags :)

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.

2 participants