Skip to content

Commit b908fbe

Browse files
committed
docs: cleanup
1 parent 42728ad commit b908fbe

File tree

121 files changed

+507
-507
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

121 files changed

+507
-507
lines changed

COMMERCIAL_LICENSE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,6 @@ IN WITNESS WHEREOF, the parties have executed this Agreement as of the Effective
7070
---
7171

7272
### Schedules
73-
- **Schedule A (Scope)** define use cases, modules, user count, and region.
74-
- **Schedule B (Fees)** fees, payment schedule, and currency.
75-
- **Schedule C (Support / Updates)** support obligations, SLA, maintenance plan.
73+
- **Schedule A (Scope)** - define use cases, modules, user count, and region.
74+
- **Schedule B (Fees)** - fees, payment schedule, and currency.
75+
- **Schedule C (Support / Updates)** - support obligations, SLA, maintenance plan.

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This avoids rework and helps maintain consistent architecture.
3838

3939
## Build, test, and development commands
4040

41-
- `sbt compile` compile all modules; `sbt test` run all tests (non‑parallel).
41+
- `sbt compile` - compile all modules; `sbt test` - run all tests (non‑parallel).
4242
- Formatting: `sbt fmt` / `sbt fmtCheck`; Linting: `sbt fix` / `sbt fixCheck`.
4343
- Focused runs: `sbt core/test`, `sbt engines-spark/compile`.
4444
- CLIs: `sbt validation-cli/run` and `sbt contracts-extractor-cli/run`.
@@ -246,7 +246,7 @@ trait LegacyCompatibility[F[_] : Sync] extends ConfigurationAlgebra[F] {
246246
- A class and its companion should live together in the same file.
247247
- sealed traits and their subtypes must also be in the same file for compiler safety.
248248
- File names usually match the main type they hold.
249-
- Multi-type grouping: When types are closely related, grouping is permittedbut only when justified. The file should then use meaningful lowerCamelCase names.
249+
- Multi-type grouping: When types are closely related, grouping is permitted-but only when justified. The file should then use meaningful lowerCamelCase names.
250250
- Developer ergonomics: Having one type per file helps with navigation, findability, and code review. It avoids confusion and reduces search friction.
251251

252252
## Commit & Pull Request guidelines

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
"A partner team removed a nullable column late Friday. We couldn’t roll back in time; both teams were up all night. If that change had been a compile error, we would have slept."
4242

4343
### For Python/ETL folks (dbt/Airflow/Informatica/Talend):
44-
Think "contracts like Pydantic/Avro but enforced before jobs run," "pure functions you can test without a cluster," and "connectors/engines that make IO explicit and safe."
44+
Think "contracts like Pydantic/Avro - but enforced before jobs run," "pure functions you can test without a cluster," and "connectors/engines that make IO explicit and safe."
4545

4646
### For EMs / Staff Data Architects:
4747
You get compile‑time guarantees (not CI or runtime heuristics), a small opinionated surface, and batteries‑included defaults with escape hatches.
@@ -91,7 +91,7 @@ You get compile‑time guarantees (not CI or runtime heuristics), a small opinio
9191
## Guarantees (Non‑negotiables)
9292

9393
- Compile‑fail contracts for typed endpoints under policy lattice
94-
- Typestate builder: `build()` only when complete incomplete pipelines can’t compile
94+
- Typestate builder: `build()` only when complete - incomplete pipelines can’t compile
9595
- Pure transforms; effectful edges; idempotent side‑effects by design
9696
- See: docs/design/framework-behaviors.md
9797

@@ -118,7 +118,7 @@ Relax the policy to Backward (allows extra producer fields and missing optional/
118118
implicitly[SchemaConforms[Out, Contract, SchemaPolicy.Backward]] //
119119
```
120120

121-
**3) Build a pipeline typestate forbids incomplete builds**
121+
**3) Build a pipeline - typestate forbids incomplete builds**
122122
```scala
123123
import cats.effect.IO
124124
import com.flowforge.core.PipelineBuilder
@@ -144,9 +144,9 @@ PipelineBuilder[IO]("demo")
144144

145145
| Path | Goal | Commands |
146146
|------|------|----------|
147-
| A Examples | Try locally (no cluster) | `sbt ffDev` (compile + focused tests), `sbt ffRunSpark` (Spark local[*]) |
148-
| B Red→Green | See compile‑time error then fix | Use the snippet above; run `sbt compile` |
149-
| C New project | Scaffold with g8 | `sbt new flowforge.g8 --name="ff-demo" --organization="com.acme"` then `sbt test` / `sbt run` |
147+
| A - Examples | Try locally (no cluster) | `sbt ffDev` (compile + focused tests), `sbt ffRunSpark` (Spark local[*]) |
148+
| B - Red→Green | See compile‑time error then fix | Use the snippet above; run `sbt compile` |
149+
| C - New project | Scaffold with g8 | `sbt new flowforge.g8 --name="ff-demo" --organization="com.acme"` then `sbt test` / `sbt run` |
150150

151151
## Compatibility
152152

docs/adr/000-template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```markdown
2-
# ADR 000 <Title>
2+
# ADR 000 - <Title>
33

44
- **Status**: Proposed / Accepted / Superseded by ADR-XXX
55
- **Date**: <YYYY-MM-DD>
@@ -22,8 +22,8 @@
2222
- Operational: <perf, observability, testing>
2323

2424
## Alternatives Considered
25-
- Option A <why rejected>
26-
- Option B <why rejected>
25+
- Option A - <why rejected>
26+
- Option B - <why rejected>
2727

2828
## Verification
2929
- Build/test steps (sbt compile/scalafmtAll/test).

docs/adr/001-effect-system-abstraction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```markdown
2-
# ADR 001 Unified Effect System Abstraction (EffectSystem[F[_]])
2+
# ADR 001 - Unified Effect System Abstraction (EffectSystem[F[_]])
33

44
- Status: Accepted
55
- Date: 2025-09-04
@@ -32,7 +32,7 @@ We require a unified abstraction over effect systems to support IO boundaries, r
3232

3333
## Milestones
3434
- M1: IO/ZIO instances audited with law/property tests (present).
35-
- M2: Leaf modules depend on `EffectSystem[F]` only (no direct IO/ZIO)see Evidence and Plan.
35+
- M2: Leaf modules depend on `EffectSystem[F]` only (no direct IO/ZIO)-see Evidence and Plan.
3636
- M3: Observability and resource-safety wired at IO boundaries (see ADR-007, ADR-013).
3737

3838
## Open Questions

docs/adr/002-spark-purity-and-io-boundaries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```markdown
2-
# ADR 002 Spark Purity and Effectful IO Boundaries
2+
# ADR 002 - Spark Purity and Effectful IO Boundaries
33

44
- Status: Accepted
55
- Date: 2025-09-04

docs/adr/003-contracts-first-and-typed-path.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```markdown
2-
# ADR 003 Contracts-First and Typed Compile-Time Path
2+
# ADR 003 - Contracts-First and Typed Compile-Time Path
33

44
- Status: Accepted
55
- Date: 2025-09-04

docs/adr/004-modules-engines-and-templates-alignment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```markdown
2-
# ADR 004 Modules, Engines, and Templates Alignment
2+
# ADR 004 - Modules, Engines, and Templates Alignment
33

44
- Status: Accepted
55
- Date: 2025-09-04

docs/adr/005-quality-and-deequ-adapter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```markdown
2-
# ADR 005 Quality and Deequ Adapter MVP
2+
# ADR 005 - Quality and Deequ Adapter MVP
33

44
- Status: Proposed
55
- Date: 2025-09-04

docs/adr/006-connectors-strategy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```markdown
2-
# ADR 006 Connectors Strategy (Local/HDFS now; Cloud later)
2+
# ADR 006 - Connectors Strategy (Local/HDFS now; Cloud later)
33

44
- Status: Accepted
55
- Date: 2025-09-04

0 commit comments

Comments
 (0)