crate / crate/crate-docs

Lint check: links and section header labels

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

Description

- [ ] add check for anchors uses in links that go to our own docs (consider how this would change if we switched to using the Sphinx interdocs links plugin)

- [ ] add check for section headings without an explicit ID. to avoid heading rewordings from breaking existing links (e.g., https://crate.io/docs/crate/reference/en/latest/general/builtins/table-functions.html#generate-series-start-stop-step)

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.