openlibhums / openlibhums/memory-alpha

Basic docs testing

Open
#95 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Markdown
Stars
0
Forks
0
Avg merge
4d 14h
Merged PRs (30d)
2

Description

Description or user story

As documentation authors, we check for broken links and broken image paths, but we cannot be 100% sure at all times that we have checked everything.

I think we should write a few tests that crawl the support site and check for broken paths and broken relative links.

We should also add the support pages to the Axe accessibility test.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the support site pages and the existing test entry point, then review how the site is built and how Axe accessibility tests are configured. Done means tests crawl the support site for broken paths and relative links and include the support pages in the Axe checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
accessibility, documentation, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.