Skip to content

Improve docs and repository hygiene#39

Merged
kPsarakis merged 9 commits into
mainfrom
sanitization
Jun 7, 2026
Merged

Improve docs and repository hygiene#39
kPsarakis merged 9 commits into
mainfrom
sanitization

Conversation

@jorgeSia

@jorgeSia jorgeSia commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

This PR includes small changes to the docs to align with the current code.

Summary

  • Fix README, quickstart, and experiment docs drift
  • Clarify enable_compression, use_composite_keys, and INGRESS_TYPE
  • Expand environment variable documentation for coordinator, worker, and advanced runtime tuning
  • Document Docker prune behavior in local cluster scripts
  • Align CI/test dependency pins and small repo hygiene items

@jorgeSia jorgeSia requested a review from kPsarakis June 6, 2026 19:00
kPsarakis
kPsarakis previously approved these changes Jun 7, 2026
@codecov

codecov Bot commented Jun 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.92%. Comparing base (d646bb8) to head (6f2495a).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #39   +/-   ##
=======================================
  Coverage   86.92%   86.92%           
=======================================
  Files          45       45           
  Lines        2661     2661           
=======================================
  Hits         2313     2313           
  Misses        348      348           
Flag Coverage Δ
coordinator 93.40% <ø> (ø)
integration 9.05% <ø> (ø)
styx-package 82.76% <ø> (ø)
worker 83.69% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kPsarakis kPsarakis 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.

Thanks for the contribution @jorgeSia !

@kPsarakis kPsarakis merged commit d09e58c into main Jun 7, 2026
8 checks passed
@kPsarakis kPsarakis deleted the sanitization branch June 7, 2026 08:40
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