Skip to content

Conversation

@alex-hunt-materialize
Copy link
Contributor

@alex-hunt-materialize alex-hunt-materialize commented Nov 20, 2025

Materialize CRD documentation improvements.

  • Hide deprecated fields.
  • Sort fields required first, then alphabetically.
  • Link from documented types to their descriptions.
  • Even out the spacing of the type, description, and default.

Motivation

Tips for reviewer

Individual commits for each change.

Docs preview

Checklist

  • This PR has adequate test coverage / QA involvement has been duly considered. (trigger-ci for additional test/nightly runs)
  • This PR has an associated up-to-date design doc, is a design doc (template), or is sufficiently small to not require a design.
  • If this PR evolves an existing $T ⇔ Proto$T mapping (possibly in a backwards-incompatible way), then it is tagged with a T-proto label.
  • If this PR will require changes to cloud orchestration or tests, there is a companion cloud PR to account for those changes that is tagged with the release-blocker label (example).
  • If this PR includes major user-facing behavior changes, I have pinged the relevant PM to schedule a changelog post.

@alex-hunt-materialize alex-hunt-materialize changed the title Crd docs improvements Materialize CRD docs improvements Nov 20, 2025
@alex-hunt-materialize alex-hunt-materialize marked this pull request as ready for review November 20, 2025 14:03
Copy link
Contributor

@kay-kim kay-kim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!!!

@alex-hunt-materialize alex-hunt-materialize merged commit 975c0cd into MaterializeInc:main Nov 20, 2025
133 checks passed
@alex-hunt-materialize alex-hunt-materialize deleted the crd_docs_improvements branch November 20, 2025 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants