Visit Page
4
1
Fork
You've already forked pages
2

Minor editing changes #63

Merged
desertsagebrush merged 3 commits from fix/broken-links into main 2025年10月20日 19:45:03 +02:00
desertsagebrush commented 2025年10月18日 08:21:33 +02:00 (Migrated from github.com)
Copy link

Just some minor documentation fixes, primarily fixing some broken links.

Just some minor documentation fixes, primarily fixing some broken links.
desertsagebrush commented 2025年10月18日 08:23:30 +02:00 (Migrated from github.com)
Copy link

Note that some of the (internal) links throughout the documentation include the black-magic.org URL path directly, and some are relative links within the site. I'm glad to go through and standardize these to all be relative (or external) in this pull request, but I wanted to bring that up before making that change.

Note that some of the (internal) links throughout the documentation include the `black-magic.org` URL path directly, and some are relative links within the site. I'm glad to go through and standardize these to all be relative (or external) in this pull request, but I wanted to bring that up before making that change.
desertsagebrush commented 2025年10月18日 08:26:25 +02:00 (Migrated from github.com)
Copy link

(Noting that several of those are my fault, in this PR even...)

(Noting that several of those are my fault, in this PR even...)

We would suggest standardising on relative links - MyST parser and Sphinx will resolve, eg, [Hardware Page](hardware.md) to the full URI for the rendered supported hardware page on the website, and this saves on having to maintain this ourselves.

We would suggest standardising on relative links - MyST parser and Sphinx will resolve, eg, `[Hardware Page](hardware.md)` to the full URI for the rendered [supported hardware](https://black-magic.org/hardware.html) page on the website, and this saves on having to maintain this ourselves.
desertsagebrush commented 2025年10月18日 19:49:29 +02:00 (Migrated from github.com)
Copy link

That was my thought, but it was late at night and I was sleep-deprived 😅. I've touched those up, as well as gone through the couple of blog posts that I noticed had non-internal links (in a separate commit). Glad to drop that if there is an issue there.

That was my thought, but it was late at night and I was sleep-deprived :sweat_smile:. I've touched those up, as well as gone through the couple of blog posts that I noticed had non-internal links (in a separate commit). Glad to drop that if there is an issue there.
dragonmux left a comment
Copy link

Only got a couple of notes on review - with them taken care of we'll be happy to get this PR merged.

Only got a couple of notes on review - with them taken care of we'll be happy to get this PR merged.
@ -1,10 +1,10 @@
# Firmware Upgrade

This needs to be careful not to imply that stlink-tool can be used to upgrade BMPs - it can only be used to upgrade ST-Link v2's running the BMD firmware. For why we're being picky about this, it's part of trying to enforce the project's terminology to help keep things disambiguated.

This needs to be careful not to imply that `stlink-tool` can be used to upgrade BMPs - it can only be used to upgrade ST-Link v2's running the BMD firmware. For why we're being picky about this, it's part of trying to enforce the project's [terminology](https://black-magic.org/knowledge/terminology.html) to help keep things disambiguated.
@ -51,7 +51,7 @@ You can check if everything is working correctly by running:
bmputil-cli probe info

Think the word "which" was fine here, just that the full stop should have been a comma and the first letter un-capitalised.

Think the word "which" was fine here, just that the full stop should have been a comma and the first letter un-capitalised.
desertsagebrush (Migrated from github.com) reviewed 2025年10月20日 19:37:34 +02:00
@ -51,7 +51,7 @@ You can check if everything is working correctly by running:
bmputil-cli probe info
desertsagebrush (Migrated from github.com) commented 2025年10月20日 19:37:34 +02:00
Copy link

Fixed!

Fixed!
desertsagebrush (Migrated from github.com) reviewed 2025年10月20日 19:38:35 +02:00
@ -1,10 +1,10 @@
# Firmware Upgrade
desertsagebrush (Migrated from github.com) commented 2025年10月20日 19:38:35 +02:00
Copy link

I dropped stlink-tool from that list; let me know if you want me to emphasize this further.

(I definitely understand the reasoning for trying to disambiguate it.)

I dropped stlink-tool from that list; let me know if you want me to emphasize this further. (I definitely understand the reasoning for trying to disambiguate it.)
dragonmux left a comment
Copy link

LGTM, merging. Thank you for the contribution and fixing all those links!

LGTM, merging. Thank you for the contribution and fixing all those links!
Sign in to join this conversation.
No reviewers
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
blackmagic-debug/pages!63
Reference in a new issue
blackmagic-debug/pages
No description provided.
Delete branch "fix/broken-links"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?