Skip to content

Improve local style checking #3691

@gingerwizard

Description

@gingerwizard

Plan is to move all style checking to yarn check-style so users can check before committing. This is missing:

  • 1. Link checking
  • 2. Frontmatter check
  • 3. Dangling pages

(2) and (3) can be implemented as scripts - we can maintain the current implementations as well which are Docusauraus hooks.

Link checking is more complex as we have relative paths and .md imports. When we move clickhouse repo docs to clickhouse-docs we can move to url links making it fast to check. However, settings are autogenerated and will be absent - potentially causing them to be missing. We could check this setting files in though.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions