Skip to content

Document new grammar workflow - #2841

Merged
abhijna merged 11 commits into
mainfrom
marc-andre/document-vendored-grammar-workflow-28a4
Sep 22, 2026
Merged

abhijna merged 11 commits into
mainfrom
marc-andre/document-vendored-grammar-workflow-28a4

Conversation

@malaverdiere

@malaverdiere malaverdiere commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Now that we merged repositories responsible for grammars in Semgrep, which changed the tooling and steps, contributors need updated documentation.

Thanks for improving Semgrep Docs

Please ensure:

  • A subject matter expert reviews the content
  • A technical writer reviews the PR
  • This change has no security implications or else you have pinged the security team
  • Any redirects are in docs/docs.json if URLs changed
  • If you edited docs/extensions/pre-commit.md.template.mdx, CI regenerates pre-commit.mdx on this PR (no manual run-build-scripts needed)
  • Check the Mintlify bot preview link on this PR (requires PR to main)

@mintlify

mintlify Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
semgrep-docs 🟢 Ready View Preview Sep 22, 2026, 6:04 PM

Comment thread docs/contributing/adding-a-language.mdx Outdated
Comment thread docs/contributing/adding-a-language.mdx Outdated
Comment thread docs/contributing/adding-a-language.mdx Outdated
Comment thread docs/contributing/adding-a-language.mdx Outdated

@kopecs kopecs left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks mostly good but I would drop the numbers from the headings for consistency and double check the formatting, some of it seemed rendered poorly on github.

@abhijna abhijna left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Hi @malaverdiere! These docs haven't been touched in a while, so while I was here, I made a few updates to better align them with the Semgrep technical writing style. I also incorporated some of @kopecs's suggestions.

I'll approve this now and can merge it if everything looks good to you.

@malaverdiere
malaverdiere force-pushed the marc-andre/document-vendored-grammar-workflow-28a4 branch from 56033ed to dcaa7da Compare September 22, 2026 17:31
@malaverdiere malaverdiere changed the title Marc andre/document vendored grammar workflow 28a4 Document new grammar workflow Sep 22, 2026
@abhijna
abhijna merged commit b6975d5 into main Sep 22, 2026
4 of 5 checks passed
@abhijna
abhijna deleted the marc-andre/document-vendored-grammar-workflow-28a4 branch September 22, 2026 19:15
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.

4 participants