PrestaShop / PrestaShop/docs

Add a CI step to validate all Links on the devdocs

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

Nobody has claimed this yet.

improvement
Dominant language
Scala
Stars
136
Forks
555
Avg merge
4d 14h
Merged PRs (30d)
4

Description

I found a broken href on https://devdocs.prestashop.com/1.7/development/page-reference/back-office/order/refunds/

It might be possible to find all of these broken links using a crawler that go on each page of the devdocs and validate each link. @boubkerbribri I think you have the Link Checker for this ?

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 with the devdocs page at https://devdocs.prestashop.com/1.7/development/page-reference/back-office/order/refunds/ and inspect the repository's CI configuration and any available Link Checker. Run the checker against the devdocs, confirm it detects the reported broken href, and make the CI step fail when broken links are found.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.