cozy / cozy/cozy.github.io

Fix broken links

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

Nobody has claimed this yet.

Dominant language
Python
Stars
88
Forks
47
PR merge metrics
No merged PRs in 30d

Description

With remark-no-dead-links, it is possible to detect links that
return 404.

remark -u remark-lint-no-dead-urls . -o

I've cleaned a bit the output:

src/howTos/dev/cordova.md
      22:16-22:92  warning  Link to https://github.com/cozy/cozy-drive/tree/master/src/lib/cozy-client is dead                 no-dead-urls                remark-lint
     134:4-134:80  warning  Link to http://stateofjs.com/2016/buildtools/ is dead                                              no-dead-urls                remark-lint
    199:5-199:108  warning  Link to https://developer.android.com/studio/run/device.html is dead                               no-dead-urls                remark-lint

src/tutorials/data/advanced.md
  339:214-339:315  warning  Link to https://wiki.apache.org/couchdb/HTTP_Bulk_Document_API#Posting_Existing_Revisions is dead  no-dead-urls                remark-lint

src/tutorials/data/queries.md
   156:35-156:115  warning  Link to https://docs.couchdb.org/en/3.0.0/config/indexbuilds.html is dead                          no-dead-urls                remark-lint

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 src/howTos/dev/cordova.md, src/tutorials/data/advanced.md, and src/tutorials/data/queries.md, then run the shown remark command to confirm the reported dead URLs. Update the five listed links to valid destinations and rerun the check; done means these warnings no longer appear.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.