crate / crate/crate-docs

Enforce use of "en/latest" in cross-links

Open
#1 0 comments 0 reactions 0 assignees View on GitHub
docs enhancement meta
Dominant language
Shell
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Description

it is going to be very easy to accidentally cross-link to a document using the URL that appears in the browser when you visit it. this URL is typically going to include the version information, e.g.:

https://crate.io/docs/crate/reference/en/4.2/sql/statements/select.html

all internal links in our docs should use "en/latest" instead of linking to a specific version. so the above link should be changed to this:

https://crate.io/docs/crate/reference/en/latest/sql/statements/select.html

we should be able to lint for this

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.