Skip to content

Docs: Fix formatting of GitHub Actions content#19241

Merged
adityasharad merged 2 commits intogithub:mainfrom
adityasharad:actions/fix/docs-table-block-formatting
Apr 8, 2025
Merged

Docs: Fix formatting of GitHub Actions content#19241
adityasharad merged 2 commits intogithub:mainfrom
adityasharad:actions/fix/docs-table-block-formatting

Conversation

@adityasharad
Copy link
Copy Markdown
Collaborator

@adityasharad adityasharad commented Apr 8, 2025

Discovered in internal review of docs preview.
Use double backticks to render inline code blocks. Use __ after inline hyperlinks.
Use an extra blank line to format the Actions library predicates table correctly. Fix some rogue references to Ruby and case inconsistency.
Place GitHub Actions link lower in sidebar (order by human-readable language name).

Discovered in internal review of docs preview.
Use double backticks to render inline code blocks.
Use __ after inline hyperlinks.
Use an extra blank line to format the Actions library predicates table correctly.
Fix some rogue references to Ruby and case inconsistency.
Copilot AI review requested due to automatic review settings April 8, 2025 00:34
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.

Files not reviewed (5)
  • docs/codeql/codeql-language-guides/codeql-for-actions.rst: Language not supported
  • docs/codeql/codeql-language-guides/codeql-library-for-actions.rst: Language not supported
  • docs/codeql/codeql-language-guides/customizing-library-models-for-actions.rst: Language not supported
  • docs/codeql/codeql-language-guides/customizing-library-models-for-ruby.rst: Language not supported
  • docs/codeql/reusables/supported-frameworks.rst: Language not supported

Order by the human-readable language name
that is rendered,
i.e. 'GitHub Actions', not 'actions'.
Copy link
Copy Markdown
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

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

These changes look spot on.

Screenshot of preview of Supported languages and frameworks with links correctly formatted. Screenshot of preview of CodeQL library for GitHub Actions with Workflows table formatted correctly.

Comment thread docs/codeql/codeql-language-guides/codeql-library-for-actions.rst
Copy link
Copy Markdown
Contributor

@coadaflorin coadaflorin left a comment

Choose a reason for hiding this comment

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

This looks good to me!

@adityasharad adityasharad merged commit 21af1c6 into github:main Apr 8, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants