AlexsLemonade / AlexsLemonade/scpca-docs

Add URL checker functionality to GHA

Open
#15 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
0
Forks
1
Avg merge
2d 21h
Merged PRs (30d)
1

Description

_Broken out from #12_

If we want to link to code where we perform certain actions we are documenting (e.g., generating a splici index [#12], run alevin-fry, generate a QC report), it is easy to envision a scenario where the link to the code is updated and the link in the docs is broken.

We will want to implement some sort of URL checker which ensures that the links we provide in the docs aren't broken. I know @davidsmejia did something similar for the links between refine.bio examples and the refine.bio frontend.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing issue #12 and the documentation links it discusses, then inspect how GitHub Actions is used in the repository. Define the URL-checking approach and its scope before implementing it. Done means the workflow detects broken links to documented code and reports them.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.