docs: Document API Stability and Compatibility#757
Merged
Conversation
Deploying redwood-sdk-docs with
|
| Latest commit: |
60fe933
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b9e623f5.redwood-sdk-docs.pages.dev |
| Branch Preview URL: | https://document-experimental-apis.redwood-sdk-docs.pages.dev |
justinvdm
added a commit
that referenced
this pull request
Sep 25, 2025
commit a5dcc79 Author: justinvdm <justinvderm@gmail.com> Date: Thu Sep 25 04:28:50 2025 +0200 Implement HMR for use client and use server directives. commit e353495 Author: justinvdm <justinvderm@gmail.com> Date: Thu Sep 25 03:14:32 2025 +0200 tests: Temporarily remove yarn classic from build matrix for E2E We are still covered by smoke tests for it. commit be1d1d2 Author: justinvdm <justinvderm@gmail.com> Date: Thu Sep 25 03:08:56 2025 +0200 tests: Avoid dev e2e tests waiting on deployments and vice versa commit 3bf3c6f Author: Justin van der Merwe <justinvderm@gmail.com> Date: Thu Sep 25 02:16:17 2025 +0200 fix: CI failures (#778) * **Concurrent Test Execution**: The test harness now provisions dev and deployment environments concurrently within the `beforeAll` hook. The `testDev` and `testDeploy` helpers were updated to use `test.concurrent`. * **Shared Browser Instance**: A `globalSetup` file was added to the Vitest configuration. It launches a single browser instance and writes its WebSocket endpoint to a temporary file. Tests now connect to this shared instance. * **Server Readiness Polling**: The `runDevServer` and `createDeployment` functions now poll their respective server URLs after the process is spawned. The functions only return after a successful `fetch` response is received. * **Refactored Polling Utility**: The `poll` function was moved to its own module and refactored to accept an options object. A `minTries` parameter was added, and all call sites were updated to use the new signature. commit adf0427 Author: justinvdm <justinvderm@gmail.com> Date: Wed Sep 24 17:32:41 2025 +0200 Remove retry script from e2e tests. commit ad7fa16 Author: Justin van der Merwe <justinvderm@gmail.com> Date: Wed Sep 24 15:30:19 2025 +0200 docs: Document API Stability and Compatibility (#757) To prepare for a 1.0 beta release, we need to communicate which parts of the SDK are stable and which are experimental. This update establishes a system for marking experimental APIs directly within the documentation. We've implemented a convention where experimental pages or specific functions are marked with an 'Experimental' badge. This is handled by adding an `experimental: true` flag to the frontmatter of relevant documentation pages, which then conditionally renders the badge in the page title. This provides clear, inline guidance to users about the stability of different features. commit 57c99a9 Author: justinvdm <justinvderm@gmail.com> Date: Wed Sep 24 14:06:02 2025 +0200 Configure vitest with concurrency and timeout settings. commit 5b91076 Author: justinvdm <justinvderm@gmail.com> Date: Wed Sep 24 13:23:02 2025 +0200 tests: Cleanup stale workers on a job
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
To prepare for a 1.0 beta release, we need to communicate which parts of the SDK are stable and which are experimental. This update establishes a system for marking experimental APIs directly within the documentation. We've implemented a convention where experimental pages or specific functions are marked with an 'Experimental' badge. This is handled by adding an
experimental: trueflag to the frontmatter of relevant documentation pages, which then conditionally renders the badge in the page title. This provides clear, inline guidance to users about the stability of different features.