GithubHelp home page GithubHelp logo

Check for broken links about documentation HOT 6 OPEN

purescript avatar purescript commented on June 19, 2024
Check for broken links

from documentation.

Comments (6)

paf31 avatar paf31 commented on June 19, 2024 1

Using https://www.npmjs.com/package/markdown-link-check gives the complete list:

$ find . -name '*.md' | cut -c 3- | xargs -L 1 markdown-link-check | grep ✖

[✖] https://github.com/purescript/purescript/tree/master/psc-ide-server
[✖] https//pursuit.purescript.org/
[✖] https://github.com/purescript/purescript/tree/master/psc-ide-server
[✖] http://purescript.readthedocs.org
[✖] http://tryps.functorial.com
[✖] https://github.com/purescript/purescript-promises
[✖] http://purescript.readthedocs.org/en/latest/prelude.html
[✖] http://functorial.com/purescript
[✖] language/Related-Projects.md

from documentation.

grdryn avatar grdryn commented on June 19, 2024

I happened to come across a couple of broken links here, so putting a PR together. I'll see if there are any others so that maybe my PR can satisfy this issue.

from documentation.

hdgarrood avatar hdgarrood commented on June 19, 2024

Any PRs fixing broken links would be very welcome :) I wouldn't put effort in writing a script to check just yet, though, as I would like to switch over to Sphinx at some point, which will do this for us.

from documentation.

grdryn avatar grdryn commented on June 19, 2024

@hdgarrood #7 fixes almost all of the broken links.

There are some in Pre-0.5-changelog.md that I didn't bother trying to find working links for.

There's also one link broken under History in Wikipedia-Page-Proposal.md. The relevant part there is:

Historical note: first SlamData PS commit on May 9, 2014 (https://github.com/slamdata/slamdata-nodewebkit/commit/73e3c9d5710ebf21552699e6bbe87f412171aec8)

and the slamdata/slamdata-nodewebkit at least doesn't seem to be a publicly accessible repo any longer.

from documentation.

grdryn avatar grdryn commented on June 19, 2024

I wouldn't put effort in writing a script to check just yet, though, as I would like to switch over to Sphinx at some point, which will do this for us.

@hdgarrood ah, that's what you meant by "Check for broken links"? I guess #7 fixes this for a single point in time only then. :)

from documentation.

subttle avatar subttle commented on June 19, 2024

Currently a broken link for "psc-ide" here:
https://github.com/purescript/documentation/blob/master/ecosystem/Editor-and-tool-support.md

It was suggested on IRC that the link should now point to:
https://github.com/purescript/documentation/blob/master/guides/psc-ide-FAQ.md

from documentation.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.