Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ Native and E2E examples; narrow with test-file, suite, scheme, or flow arguments
- Follow [`STYLE_GUIDE.md`](./STYLE_GUIDE.md) for human-authored prose. Authored docs live in
`documentation/`; generated TypeDoc output lives in `docs/`.
- Preserve existing README families: repo/package/reference implementation headers, navigation, and
pre-release warnings; documentation indexes; short status READMEs for placeholders or
release-status warnings where applicable; documentation indexes; short status READMEs for placeholders or
internal-only surfaces.
- Use sentence-case Markdown headings, official product/API casing, fenced code blocks with language
tags, and `pnpm` commands.
Expand Down
8 changes: 2 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@

</div>

> [!WARNING]
>
> The Optimization SDK Suite is pre-release (alpha). Breaking changes can be published at any time.

We appreciate community contributions in the form of issues and pull requests.

Use this guide when you change SDK packages, reference implementations, documentation, release
Expand Down Expand Up @@ -104,8 +100,8 @@ pnpm version:pnpm
| -------------------- | ----------------------------------------------------------------------------------- |
| `lib/` | Internal shared tooling and mock services, such as `build-tools` and `mocks` |
| `packages/` | Workspace packages, including published SDKs and framework layers |
| `packages/android/` | Pre-release Android library |
| `packages/ios/` | Pre-release Swift package |
| `packages/android/` | Beta Android library |
| `packages/ios/` | Beta Swift package |
| `implementations/` | Reference apps used for integration testing, validation evidence, and E2E coverage |
| `documentation/` | Authored guides and concepts published with TypeDoc |
| `docs/` | Generated TypeDoc output |
Expand Down
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@

</div>

> [!WARNING]
>
> The Optimization SDK Suite is pre-release (alpha). Breaking changes can be published at any time.

## Introduction

A [pnpm](https://pnpm.io/) monorepo hosting a suite of SDKs, supporting libraries, and reference
Expand Down Expand Up @@ -91,21 +87,21 @@ General selection rules:

## Native and planned SDKs

React Native support is available through
React Native support is available as a beta SDK through
[`@contentful/optimization-react-native`](./packages/react-native-sdk/README.md).

Native iOS work is also present in this repository as a pre-release Swift Package under
Native iOS work is also present in this repository as a beta Swift Package under
[`packages/ios`](./packages/ios/README.md), backed by the shared
[`@contentful/optimization-js-bridge`](./packages/universal/optimization-js-bridge/README.md)
adapter and the [iOS reference app](./implementations/ios-sdk/README.md). Treat this surface as
alpha implementation work rather than a stable public native SDK.
beta implementation work rather than a stable public native SDK.

Native Android support is also present as a pre-release Kotlin Android library under
Native Android support is also present as a beta Kotlin Android library under
[`packages/android`](./packages/android/README.md), published as the Maven AAR
`com.contentful.java:optimization-android`, backed by the shared
[`@contentful/optimization-js-bridge`](./packages/universal/optimization-js-bridge/README.md)
adapter and the [Android reference app](./implementations/android-sdk/README.md). Treat this surface
as alpha implementation work rather than a stable public native SDK.
as beta implementation work rather than a stable public native SDK.

The following framework SDKs are planned but are not published from this repository:

Expand Down
1 change: 0 additions & 1 deletion documentation/authoring/recipes/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ is explicit in the blueprint; shared copy must not infer an SDK family or restat
Voice: plain and direct, warm but not chatty. No hype or filler that reads oddly in a reference doc
("this is the payoff", "the magic happens here", "boom", gratuitous "just"). Describe the current SDK
in present tense — never narrate change ("no longer", "now supports", "used to", PR/issue numbers).
While the SDK is pre-release, document the single current version; do not compare SDK versions.

Structure invariants (`pnpm guides:check` enforces the blueprint-to-guide section and category map):

Expand Down
2 changes: 1 addition & 1 deletion documentation/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Server and web SDK guides are listed before native and mobile SDK guides.

### Native and mobile SDKs

Native iOS and Android guides route to pre-release alpha surfaces.
Native and mobile SDK guides route to beta SDK surfaces.

| Guide | Runtime or app type | Package |
| ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- | ------------------------------------------ |
Expand Down
Loading
Loading