Skip to content

Commit c75e35d

Browse files
committed
Clarify future SDK repository boundary
1 parent 10bcdf1 commit c75e35d

2 files changed

Lines changed: 17 additions & 0 deletions

File tree

ROADMAP.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,13 @@ placeholder crates; if names are claimed on crates.io, they should contain real
150150
project-owned packages with clear README text pointing to the correct binary
151151
and SDK roles.
152152

153+
Keep the SDK code in a clearly split directory from the proxy implementation,
154+
for example `crates/fluxheim-sdk/`, with its own `Cargo.toml`, README, tests,
155+
and public API boundary. The initial workspace setup may live in this
156+
repository for shared CI and review, but the layout should make it possible to
157+
move `fluxheim-sdk` into its own GitHub project later without untangling proxy
158+
internals.
159+
153160
Farther down the line, Fluxheim should also grow a dependency-reduction track:
154161
once the major web, cache, PHP, proxy, load-balancer, and extension surfaces are
155162
stable, move bounded Fluxheim-specific logic in-tree and keep large external

docs/versioning-plan.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2210,6 +2210,16 @@ Crate naming and crates.io hygiene:
22102210
project-owned packages with README text explaining the difference between the
22112211
binary package and the SDK.
22122212

2213+
Repository/layout rule:
2214+
2215+
- place SDK code in a separate workspace directory such as
2216+
`crates/fluxheim-sdk/`, with its own `Cargo.toml`, README, tests, examples,
2217+
and public API boundary;
2218+
- do not mix SDK code into the proxy binary's `src/` modules;
2219+
- the initial workspace can live in the Fluxheim repository for shared CI, but
2220+
the directory and dependency boundary should let the SDK move to its own
2221+
GitHub project later without extracting proxy internals.
2222+
22132223
### 1.7 - Reserved
22142224

22152225
Compression was pulled forward into the `1.4` production proxy parity line

0 commit comments

Comments
 (0)