Skip to content

docs: streaming-only positioning in README/CLAUDE.md + quiet dependabot - #33

Merged
FBumann merged 2 commits into
chore/post-repositioning-scanfrom
docs/streaming-positioning
Jul 24, 2026
Merged

docs: streaming-only positioning in README/CLAUDE.md + quiet dependabot#33
FBumann merged 2 commits into
chore/post-repositioning-scanfrom
docs/streaming-positioning

Conversation

@FBumann

@FBumann FBumann commented Jul 24, 2026

Copy link
Copy Markdown
Owner

Stacked on #32 (auto-retargets to main when it merges). Two things, per discussion:

Step-6 docs pass — the user-facing docs catch up with #26's repositioning:

  • README examples lead with the native runner (ly.solve(...)) everywhere; Model.from_yaml appears only in use case 2, behind an explicit import linopy_yaml.compat.
  • The mini diagram now shows the truth: out-of-language constructs are load errors naming the construct; the linopy compat/oracle lane is a detached, dotted, opt-in row — not a runtime fallback. (Rendered and validated with mermaid-cli.)
  • Installation reflects the flipped extras: pip install linopy-yaml is the streaming engine; [oracle] adds the compat layer.
  • CLAUDE.md: overview rewritten, package structure defers to ARCHITECTURE.md's (test-enforced) module map, API section is native-first with the compat recipe second, guidelines point at the enforced hard rules.

Dependabot, quiet by design — fluxopt's structure (pip + github-actions, labels, chore/ci prefixes) at quarterly cadence with one grouped PR per ecosystem; security updates are cadence-independent; open-pull-requests-limit: 0 documented inline as the full-silence knob.

🤖 Generated with Claude Code

FBumann and others added 2 commits July 24, 2026 19:10
fluxopt's structure (pip + github-actions, labels, chore/ci prefixes)
at quarterly cadence with one grouped PR per ecosystem. Security
updates are cadence-independent; open-pull-requests-limit: 0 is the
documented knob for full version-update silence.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Step 6 of the repositioning plan. README: native runner (ly.solve) is
the front door in every example, the compat layer appears as the
explicit opt-in it now is (import linopy_yaml.compat, [oracle] extra),
the mini diagram shows out-of-language constructs as load errors with
the compat lane as a detached dotted row, and Installation reflects
the flipped extras (bare install IS the streaming engine). CLAUDE.md:
overview, package structure (deferring to ARCHITECTURE.md's enforced
module map), native-first API section, and guidelines aligned with the
enforced hard rules.

Plus the quarterly grouped dependabot config (quiet by design;
security updates cadence-independent).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ba98e720-c86f-44f7-9cfb-b15ed9ccb8d7

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/streaming-positioning

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@FBumann
FBumann merged commit 33216ab into chore/post-repositioning-scan Jul 24, 2026
4 checks passed
FBumann added a commit that referenced this pull request Jul 26, 2026
#33 merged into `chore/post-repositioning-scan` 49 minutes after that branch
had already merged into main and closed, so its content never landed. GitHub
reports the PR as merged and the branch is gone, which is why nobody noticed.

Only this file is worth recovering. The rest of #33 was README/CLAUDE.md
positioning that described a world since dismantled — an `[oracle]` extra
(now `[compat]`), `Model.from_yaml` / `m.yaml.extend` / `_patch.py` /
`accessor.py` (now `compat.build` / `compat.extend`), `mypy` (now pyrefly),
`ly.write_lp` (now `ly.write`) — and the README section it edited was
rewritten wholesale by #87 and #88. Restoring any of it would regress the
docs.

The config is unchanged from #33: quarterly, everything grouped into one PR
per ecosystem, so version bumps arrive four times a year instead of
continuously. Security advisories are unaffected — GitHub raises those
regardless of this cadence.

Verified against the repo as it stands now rather than as it was: `chore` and
`ci` are both accepted by the conventional-commit check
(`.github/workflows/pr-title.yaml`), and the `dependencies` label the config
references did not exist, so it has been created — without it dependabot
drops the label silently.

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
@FBumann
FBumann deleted the docs/streaming-positioning branch July 31, 2026 10:51
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