Skip to content

Document Ruff rollout lessons and shared engineering guidance - #3

Merged
adewale merged 1 commit into
mainfrom
docs/ruff-rollout-lessons-20261009
Oct 9, 2026
Merged

adewale merged 1 commit into
mainfrom
docs/ruff-rollout-lessons-20261009

Conversation

@adewale

@adewale adewale commented Oct 9, 2026 •

Copy link
Copy Markdown
Owner

What

Capture the repository's Workers runtime/CI lessons, reusable engineering guidance, and a dated cross-project Ruff rollout retrospective.

Why

The repairs in #2 resolved the last rollout blockers, but their operational lessons were spread across PR descriptions and chat history. The retrospective preserves evidence and distinguishes completed merges from incomplete application coverage.

How

  • Add LESSONS_LEARNED.md with the actual runtime/configuration/test-harness findings and tested versions.
  • Add docs/engineering-guidance.md for reusable diagnosis, validation, toolchain, and merge practices.
  • Add a dated retrospective covering all 29 merged rollout PRs: 28 public links and one anonymized private-repository entry, plus CI receipts and explicitly separate follow-ups.
  • Link all three documents from the README; host the shared documents here for both Workers repositories.
  • Be explicit that LangChain's XPASS is a placeholder and the Workers AI xfail does not start the server.

Validation

  • Checked the 29-PR inventory against GitHub; all are merged.
  • Validated all 8 relative links in the new documents and README section, plus 28 unique public inventory URLs and one anonymized private-repository entry.
  • uv run ruff check . and staged diff whitespace checks pass.
  • Full unchanged integration suite and Ruff passed in fresh GitHub CI on the anonymized documentation commit; Semgrep also passed.
  • Documentation only: no runtime, dependency, workflow, or application UI changes. Screenshots are not applicable.

Risk

Low. Historical claims link to merged revisions and dated CI runs; limits and floating toolchain layers are explicit. Merge this PR before the companion issues documentation PR, whose new cross-repository links point to these documents on main.

@adewale
adewale force-pushed the docs/ruff-rollout-lessons-20261009 branch from fdcbf3d to 847a9c3 Compare October 9, 2026 14:55
@adewale
adewale merged commit 774942f into main Oct 9, 2026
2 checks passed
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.

1 participant