quarto-dev / quarto-dev/quarto-cli

Linter: check remote sources

Open
#6,328 0 comments 1 reaction 1 assignee View on GitHub

@cscheid is already working on this.

Since Jul 24, 2023.

enhancement lint
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

This problem comes up with Quarto itself, and I bet is very common in other sources of technical documentation.

How can we check that the downstream source of a piece of documentation is consistent with what the documentation is stating? In Quarto, this came up with a discrepancy between our SCSS documentation and our code (https://github.com/quarto-dev/quarto-web/commit/0e49089e4755c241851b2ebf01cb831bc9cf0d94, see #6209).

Then I ran Chap. 20 of this book, which talks about "IfThisThenThat", a feature of some of Google's internal tooling.

Our usecase in quarto is a little different, but we could have our (future) linter recognize syntax for checking a different remote source for consistency (I can imagine checking against a commit in a github or gitlab repo, for example). Then, quarto lint could issue a warning about inconsistent documentation. In CI, that would probably be good enough warning.

Contributor guide

Open the contributing guide

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.