Skip to content

Fix [Sphinx] [Automation] Issue -> PR conversion of hyperlinks | Closes #221#226

Merged
plaindocs merged 4 commits into
Safety-Critical-Rust-Consortium:mainfrom
MarcosBorgesPhD:pr-221
Dec 3, 2025
Merged

Fix [Sphinx] [Automation] Issue -> PR conversion of hyperlinks | Closes #221#226
plaindocs merged 4 commits into
Safety-Critical-Rust-Consortium:mainfrom
MarcosBorgesPhD:pr-221

Conversation

@MarcosBorgesPhD

@MarcosBorgesPhD MarcosBorgesPhD commented Nov 20, 2025

Copy link
Copy Markdown
Contributor

Normalize Markdown in issue bodies to prevent parser errors and inconsistent formatting. This ensures hyperlinks in Issue -> PR conversion are correctly rendered.

Details

  • Convert inline-code links like [`text`](url) to standard [text](url)

  • Correct mixed bold/code formatting:

    **`code`** => `code`
    `**code**` => `code`
    

Notes

This is PR 1/3 in a series improving Issue -> PR conversion:

  1. PR 1: Fix hyperlinks [Sphinx] [Automation] Make sure Issue -> PR conversion of hyperlinks is correct #221
  2. PR 2: Fix code block conversion [Sphinx] [Automation] Make sure Issue -> PR conversion of code blocks is correct #211
  3. PR 3: Fix table conversion [Sphinx] [Automation] Make sure Issue -> PR conversion of tables is correct #210

Closes #221

@netlify

netlify Bot commented Nov 20, 2025

Copy link
Copy Markdown

Deploy Preview for scrc-coding-guidelines ready!

Name Link
🔨 Latest commit a8b0c6a
🔍 Latest deploy log https://app.netlify.com/projects/scrc-coding-guidelines/deploys/692f5957dd869e0008dcb589
😎 Deploy Preview https://deploy-preview-226--scrc-coding-guidelines.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@MarcosBorgesPhD MarcosBorgesPhD changed the title Fix [Sphinx] [Automation] Issue -> PR conversion of hyperlinks is correct #221 Fix [Sphinx] [Automation] Issue -> PR conversion of hyperlinks | Closes #221 Nov 20, 2025
@PLeVasseur

Copy link
Copy Markdown
Collaborator

Thanks for this @MarcosBorgesPhD! I'll try to make time this week to review

@PLeVasseur

PLeVasseur commented Dec 2, 2025

Copy link
Copy Markdown
Collaborator

Hey @MarcosBorgesPhD -- updating the spec.lock file is appreciated!

Please back that out of your PRs and do so on a separate PR if you'd like to. This helps for traceability. I'll then merge that spec.lock file update PR, and you can rebase your PRs.

@plaindocs plaindocs 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 @MarcosBorgesPhD thanks for working on this.

It looks like you have some unrelated changes in the PR, such as the updated footer, would you mind removing those?

The actual normalisation of markdown looks fine.

Comment thread .github/workflows/auto-pr-on-issue.yml Outdated
Comment thread .github/workflows/snapshot-ci.yml Outdated
Comment thread scripts/auto-pr-helper.py
@MarcosBorgesPhD

Copy link
Copy Markdown
Contributor Author

Hey @PLeVasseur and @plaindocs,

Thanks for the guidance! I have cleaned up unnecessary changes resulting from rebases. This PR now contains only the changes relevant to the issue.

Please validate the PR #236 before.

- Convert inline-code links like [`text`](url) to standard [text](url)
- Correct mixed bold/code formatting:
    - **`code`** → `code`
    - `**code**` → `code`

This prevents Markdown parser errors in issue bodies and ensures consistent formatting.
Pandoc installation is only needed for PR #228, so it has been removed from this branch.
@MarcosBorgesPhD

Copy link
Copy Markdown
Contributor Author

@plaindocs @PLeVasseur Apologies for the extra notifications.

  1. This PR has been fully rebased onto upstream/main, which should fix the CI failures.

  2. The commit contains only the files relevant to this issue.

@plaindocs plaindocs 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.

Thanks! This looks great.

@plaindocs
plaindocs added this pull request to the merge queue Dec 3, 2025
Merged via the queue into Safety-Critical-Rust-Consortium:main with commit 8ddb34e Dec 3, 2025
7 checks passed
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.

[Sphinx] [Automation] Make sure Issue -> PR conversion of hyperlinks is correct

3 participants