silverstripe / silverstripe/developer-docs

Broken internal links in docs

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

Nobody has claimed this yet.

affects/v4 affects/v5 complexity/low impact/low type/docs
Dominant language
No language data
Stars
7
Forks
74
Avg merge
1d 14m
Merged PRs (30d)
6

Description

Algolia has detected the following which are being referenced from somewhere in the docs but do not actually exist.
For those of us with access, if you click on each item in the algolia list you can see where they're being referenced from - but a simple text search should also suffice.

Note that Algolia indexed all versions of the doc, so we may need to make changes in each v3, v4, and v5 docs.

Broken links

Acceptance criteria

  • Links to any of the above are fixed in documentation to point to the correct page(s)
  • Algolia doesn't report any broken links next time it crawls the docs

Contributor guide

Open the contributing guide

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 a text search across the documentation for the listed broken URLs, checking each reference in the v3, v4, and v5 docs. Compare each target with the available documentation pages, then use the linked Algolia crawler to verify that all listed links resolve and the next crawl reports no broken links.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
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.