Prepare docs for #2067 #2127

merged 10 commits into from Nov 27, 2016


None yet

2 participants

jeddy3 commented Nov 26, 2016 edited

This PR prepares the docs for #2067 - adding links between related rules.

A while ago we started using hacky “quasi-absolute” URLs within the docs e.g. (/docs/user-guides/ This was to overcome a limitation in how the URLs were rewritten to work on the website. This approach is incompatible with linking between rules. In stylelint/ the need for this workaround was removed.

This PR updates all the “pseudo-absolute” links to use standard relative URLs.

The PR is split into a handful of commits:

  • The first set of commits are of the tweaks I made to the copy and fixing links while going through and validating all the links.
  • The latter commits are todo with the URL rewriting.

Removing the “quasi-absolute” paths has the added bonus that we can now make use of remark-validate-link, as suggested by @wooorm in June. remark-validate-link turns out to be an amazing package, and is capable of spotting invalid anchors too. It would of caught those two broken links in the FAQ that are fixed in this PR.



@jeddy3 jeddy3 merged commit ab20f8c into master Nov 27, 2016

4 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
continuous-integration/travis-ci/pr The Travis CI build passed
continuous-integration/travis-ci/push The Travis CI build passed
coverage/coveralls Coverage remained the same at 95.646%
@jeddy3 jeddy3 deleted the docs-freshen-up branch Nov 27, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment