Skip to content

Use “convention” instead of “rule” throughout documentation #67

Description

@felixarntz

The documentation alternates between “rule” and “convention” for the same Konsistent concept, while predicates are the actual individual checks inside a convention. This makes the policy hierarchy harder to understand and should use “convention” consistently.

Relevant files:

  • packages/konsistent/README.md
  • docs/README.md
  • docs/reference/configuration.md
  • docs/reference/conditional-rules.md
  • docs/guides/getting-started.md

Replace “rule” with “convention” wherever the full scoped policy is meant, including headings, filenames, links, examples, and internal identifiers that encode the documentation term. Keep “predicate” for an individual assertion.

Backward compatibility: documentation and internal terminology can be renamed or removed without compatibility shims. No konsistent.json schema change is expected; if one becomes necessary, retain the old name and behavior as deprecated and emit a non-failing CLI warning when it is used.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions