oasisprotocol / oasisprotocol/docs
Use an approximation for detecting links that break after refresh
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 15
- Forks
- 46
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 1
Description
Related to https://github.com/oasisprotocol/docs/issues/4
I found a good approximation for detecting bad links. Find any ../../ in build folder:
grep -o -E '\.\./\.\./.{0,50}' -r ./build; test $? -eq 1
And even better, find all href:"relative in build folder:
grep -o -E 'href:".{0,50}' -r ./build | grep -v -E 'href:"(https:|http:|mailto:|/|#)'; test $? -eq 1
Originally posted by @lukaw3d in https://github.com/oasisprotocol/docs/issues/27#issuecomment-1065795388
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by building the documentation and running the two grep commands against ./build to inspect relative href values and ../../ paths. No specific files or tests are named; done means the build process detects links that can break after a refresh without flagging absolute, anchor, or mailto links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- build-system, documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100