Skip to content

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

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.

Sign up for GitHub

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

Jump to bottom
Merged
plaindocs merged 4 commits into from
Dec 3, 2025
Merged

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

plaindocs merged 4 commits into from
Dec 3, 2025

Conversation

@MarcosBorgesPhD
Copy link
Contributor

@MarcosBorgesPhD MarcosBorgesPhD commented Nov 20, 2025 •
edited
Loading

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
Copy link

netlify bot commented Nov 20, 2025 •
edited
Loading

✅ 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
Collaborator

PLeVasseur commented Dec 2, 2025

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

@PLeVasseur
Copy link
Collaborator

PLeVasseur commented Dec 2, 2025 •
edited
Loading

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.

@MarcosBorgesPhD MarcosBorgesPhD force-pushed the pr-221 branch 2 times, most recently from f5232d6 to 2b72e39 Compare December 2, 2025 17:34
plaindocs
plaindocs requested changes Dec 2, 2025
View reviewed changes
Copy link
Collaborator

@plaindocs plaindocs left a comment

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.

@MarcosBorgesPhD
Copy link
Contributor Author

MarcosBorgesPhD commented Dec 2, 2025

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.

@MarcosBorgesPhD
Fix: Normalize Markdown links and formatting
d300a56 
- 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.
@MarcosBorgesPhD
Fix: address CI failure by updating snapshot-ci.yml
210bf72
@MarcosBorgesPhD
Fix: address CI failure by updating Pandoc installation
82e2619
@MarcosBorgesPhD
Remove parts requested by @plaindocs
a8b0c6a 
Pandoc installation is only needed for PR rustfoundation#228, so it has been removed from this branch.
@MarcosBorgesPhD
Copy link
Contributor Author

MarcosBorgesPhD commented Dec 2, 2025

@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 approved these changes Dec 3, 2025
View reviewed changes
Copy link
Collaborator

@plaindocs plaindocs left a comment

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 rustfoundation: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

Reviewers

@plaindocs plaindocs plaindocs approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

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

3 participants

@MarcosBorgesPhD @PLeVasseur @plaindocs