nervosnetwork / nervosnetwork/rfcs
Add ci jobs to check links
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 271
- Forks
- 158
- PR merge metrics
- No merged PRs in 30d
Description
External links are volatile. We need to check whether they are still valid regularly. There are some actions available such as https://github.com/lycheeverse/lychee-action
We also need a CI job to check internal links on PR to avoid issues like #250 . This requires a scanning of all the md files and check all the linked directories and files exist.
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 reviewing the repository's existing CI configuration and the Markdown documents it should scan. Evaluate a link-checking action for external URLs, then add a pull-request check for internal links across all Markdown files; done means both external links are checked regularly and referenced files and directories are verified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, markdown
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100