Skip to content

docs(runtime): align README with current runtime packages#1072

Merged
matheuscscp merged 1 commit into
fluxcd:mainfrom
Iam-Karan-Suresh:docs/runtime-readme-update
Jan 22, 2026
Merged

docs(runtime): align README with current runtime packages#1072
matheuscscp merged 1 commit into
fluxcd:mainfrom
Iam-Karan-Suresh:docs/runtime-readme-update

Conversation

@Iam-Karan-Suresh

@Iam-Karan-Suresh Iam-Karan-Suresh commented Jan 13, 2026

Copy link
Copy Markdown
Contributor

This PR updates the runtime README to reflect the current state of the pkg/runtime packages.

Changes include:

  • Aligning the runtime configuration options with existing packages and correcting outdated references.
  • Fixing package naming inconsistencies (e.g. jiter).
  • Adding documentation for reconciliation helpers to clarify how reconcile results integrate with patching.
  • Documenting runtime-facing packages that were previously undocumented to reduce future documentation drift.

This aims to ensure the README accurately represents the runtime APIs available to controller authors and contributors.

fix: #263

@stefanprodan stefanprodan left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

Please rebase with upstream main and force push

@stefanprodan stefanprodan added the area/docs Documentation related issues and pull requests label Jan 22, 2026
Signed-off-by: Iam-karan-suresh <karansuresh.info@gmail.com>
@Iam-Karan-Suresh Iam-Karan-Suresh force-pushed the docs/runtime-readme-update branch from a6e8f9b to 7c92e59 Compare January 22, 2026 16:26
@Iam-Karan-Suresh

Copy link
Copy Markdown
Contributor Author

Rebased with upstream main and force pushed.
Please have a look @stefanprodan . Thanks!

@stefanprodan stefanprodan left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

Thanks @Iam-Karan-Suresh 🏅

@Iam-Karan-Suresh

Copy link
Copy Markdown
Contributor Author

Thanks for the review! Appreciate it 🙌

@matheuscscp matheuscscp merged commit 8f030fe into fluxcd:main Jan 22, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation related issues and pull requests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Runtime module README.md needs updating

3 participants