Add Github Edit Links #125
Conversation
package.json
Outdated
| "spellcheck": "mdspell --en-gb --report --ignore-acronyms --ignore-numbers --no-suggestions 'content/**/*.md'", | ||
| "broken-link-local": "blcl --recursive --ordered --exclude-external ./public/", | ||
| "broken-link-all": "blcl --recursive --ordered ./public/", | ||
| "broken-link-all": "blcl --recursive --exclude https://github.com/sourcebots/docs/tree/master/content/* --ordered ./public/", |
There was a problem hiding this comment.
Please could we have an inline comment explaining the exclusion.
Meta: this will likely conflict with #117.
There was a problem hiding this comment.
Please see above note about @RealOrangeOne's comments in 1add520
I am aware that this will likely conflict, but am not sure how best to resolve this.
There was a problem hiding this comment.
I understand the reason for the exclusion; I'm asking for a comment so that it's clear to all future readers of the code.
Please bear in mind that future readers won't have to hand the comments on this PR or the original commit which removed the functionality. While they could git blame, the chances are that they'd have to chase several layers of commits to find the rationale (and then they'd need to work backwards from "Add Github Edit Links" to this PR and onwards from there). Adding a comment now is easy and makes things clearer for everyone.
There was a problem hiding this comment.
Ah, I missed the word inline and mistook the context of your request.
Fixed in 9d037ff
package.json
Outdated
| "spellcheck": "mdspell --en-gb --report --ignore-acronyms --ignore-numbers --no-suggestions 'content/**/*.md'", | ||
| "broken-link-local": "blcl --recursive --ordered --exclude-external ./public/", | ||
| "broken-link-all": "blcl --recursive --ordered ./public/", | ||
| "//": "Github links below are excluded to prevent breaking the link checker for the Edit in Github urls, when no such page exists in master", |
There was a problem hiding this comment.
Eurgh, does npm's JSON parser really not support comments?
There was a problem hiding this comment.
There was a problem hiding this comment.
ah, i never saw this hack. I'd rather remove this thing
There was a problem hiding this comment.
Removed in 4434fd3
Revert "Add explanatory comment on exclusion of certain github links from link checker" This reverts commit 9d037ff.
|
Hnng. Why is the JavaScript ecosystem so crap. This is a difficult one. I really want there to be more help to future readers of the Is there another way that we can configure the exclusions? Perhaps a config file for the tool? Alternatively, could we break that command out to a script (in the |
|
The tool has no config, although perhaps extracting it out into |
|
wrong button -_- |
|
I think pulling out a |
|
As mentioned yesterday at the tech day, the scripts are out of scope of this PR. |
|
It looks like due to a merge issue, |
…owing a BLC_UNKNOWN error which is not documented.
trickeydan
dismissed
RealOrangeOne’s stale review
Script to check links is out of scope for this PR.
4 participants
When these were recently removed in 1add520, the reason cited was that it broke the link checker. I have fixed this by excluding those links from the checker