From 68c1ef557e15f337b9f49069f631d7e1a11a4c36 Mon Sep 17 00:00:00 2001 From: Chris Thoburn Date: Tue, 12 Nov 2024 01:15:42 -0800 Subject: [PATCH] chore: give sections breathing room --- README.md | 10 ++++++++++ guides/manual/1-overview.md | 4 ++++ guides/manual/2-requests.md | 6 ++++++ guides/manual/3-data.md | 2 ++ guides/manual/4-caching.md | 12 ++++++++++++ guides/manual/5-presentation.md | 2 ++ guides/manual/6-schemas.md | 2 ++ guides/manual/7-builders.md | 2 ++ 8 files changed, 40 insertions(+) diff --git a/README.md b/README.md index 87cb861758d..ff92229bb05 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,8 @@ rich application — letting you ship better experiences more quickly withou - [Team](https://emberjs.com/team) - [Blog](https://emberjs.com/blog) +
+ ## Installation ```sh @@ -75,6 +77,8 @@ pnpm add ember-data > is currently being worked on for the Polaris experience and will > be available soon. +
+ ## Compatibility The following table lists WarpDrive/EmberData versions alongside information about @@ -100,6 +104,8 @@ project tested against at the point of release. [^1]: This version may receive special long-term patches to assist model-fragments users in creating a migration path onto 5.x and off of ModelFragments +
+ ## The Big List of Versions | Package | Audience | LTS-4-12 | LTS | Stable | Beta | Canary | @@ -127,10 +133,14 @@ project tested against at the point of release. | [@ember-data/store](./packages/store#readme) | 🌌 | ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/@ember-data/store/lts-4-12?label&color=bbbbbb) | ![NPM LTS Version](https://img.shields.io/npm/v/@ember-data/store/lts?label&color=0096ff) | ![NPM Stable Version](https://img.shields.io/npm/v/@ember-data/store/latest?label&color=90EE90) | ![NPM Beta Version](https://img.shields.io/npm/v/@ember-data/store/beta?label&color=ff00ff) | ![NPM Canary Version](https://img.shields.io/npm/v/@ember-data/store/canary?label&color=FFBF00) | | [@ember-data/tracking](./packages/tracking#readme) | 🌌🐹 | ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/@ember-data/tracking/lts-4-12?label&color=bbbbbb) | ![NPM LTS Version](https://img.shields.io/npm/v/@ember-data/tracking/lts?label&color=0096ff) | ![NPM Stable Version](https://img.shields.io/npm/v/@ember-data/tracking/latest?label&color=90EE90) | ![NPM Beta Version](https://img.shields.io/npm/v/@ember-data/tracking/beta?label&color=ff00ff) | ![NPM Canary Version](https://img.shields.io/npm/v/@ember-data/tracking/canary?label&color=FFBF00) | +
+ ## Code of Conduct Refer to the [Code of Conduct](https://github.com/emberjs/data/blob/main/CODE_OF_CONDUCT.md) for community guidelines and inclusivity. +
+ ### License This project is licensed under the [MIT License](LICENSE.md). diff --git a/guides/manual/1-overview.md b/guides/manual/1-overview.md index 0e0f80376c8..6757e2c387b 100644 --- a/guides/manual/1-overview.md +++ b/guides/manual/1-overview.md @@ -32,6 +32,8 @@ to a request-centric library and began accelerating towards our goal of becoming a universal library prepared for the demands of web applications over the coming decades. +
+ ## Why WarpDrive? WarpDrive is the data framework for building ambitious applications. @@ -58,6 +60,8 @@ This means we are as good for embedded content and MPAs as we are for SPAs. Our core philosophy is to deliver value that lasts decades and evolves with your app. +
+ | | | | -- | -- | | [← Table of Contents](./0-index.md#table-of-contents)                        |                       [Making Requests →](./2-requests.md) | diff --git a/guides/manual/2-requests.md b/guides/manual/2-requests.md index 3b5b6cbf6f0..5350fe1de50 100644 --- a/guides/manual/2-requests.md +++ b/guides/manual/2-requests.md @@ -12,6 +12,8 @@ Sources can be anything that has the ability for you to store and retrieve data: Though the actual source and connection type do not matter, in a typical app requests are fulfilled by making [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) calls against server endpoints making up an API. +
+ ### Fetch Example > [!TIP] @@ -73,6 +75,8 @@ const { content } = await manager.request({ url: '/users' }); > to type a request, look for the section on [builders](./7-builders.md) > later. +
+ ### The Chain of Responsibility When we created the request manager for our application above, you may have noticed that when we told it to fulfill requests using the `Fetch` handler we did so by passing in an array: @@ -134,6 +138,8 @@ A handler may be any object with a `request` method. This allows both stateful a > - have a clear heuristic by which they activate (a header, op-code, option, or url scheme) > - don't block response streaming (we'll talk about this later) +
+ | | | | -- | -- | | [← Introduction](./1-overview.md)                        |                       [Key Data Structures →](./3-data.md) | diff --git a/guides/manual/3-data.md b/guides/manual/3-data.md index cc58a9d9584..fa250f130de 100644 --- a/guides/manual/3-data.md +++ b/guides/manual/3-data.md @@ -20,6 +20,8 @@ Misalignment tends to occur when API and Application developers don't work toget requirements, or when the format in use is "lossy" (unable to accurately convey the full scope of information being serialized) +
+ | | | | -- | -- | | [← Making Requests](./2-requests.md)                        |                       [Caching →](./4-caching.md) | diff --git a/guides/manual/4-caching.md b/guides/manual/4-caching.md index 2bacb30ef55..f620298c95c 100644 --- a/guides/manual/4-caching.md +++ b/guides/manual/4-caching.md @@ -4,16 +4,28 @@ ## Caching +
+ ### CacheHandler +
+ ### CachePolicy +
+ ### In-Memory Cache +
+ ### Cache Eviction +
+ ### Persisted Caching +
+ | | | | -- | -- | | [← Key Data Structures](./3-data.md)                        |                       [Working with Data in your UI →](./5-presentation.md) | diff --git a/guides/manual/5-presentation.md b/guides/manual/5-presentation.md index 2aa972682dc..36329cd190b 100644 --- a/guides/manual/5-presentation.md +++ b/guides/manual/5-presentation.md @@ -4,6 +4,8 @@ ## Working with Data in your UI +
+ | | | | -- | -- | | [← Caching](./4-caching.md)                        |                       [Field Schemas →](./6-schemas.md) | diff --git a/guides/manual/6-schemas.md b/guides/manual/6-schemas.md index ebebd381139..c9e5c509219 100644 --- a/guides/manual/6-schemas.md +++ b/guides/manual/6-schemas.md @@ -4,6 +4,8 @@ ## Field Schemas +
+ | | | | -- | -- | | [← Working with Data in your UI](./5-presentation.md)                        |                       [Request Builders →](./7-builders.md) | diff --git a/guides/manual/7-builders.md b/guides/manual/7-builders.md index a19843c6d6e..410b158c0e3 100644 --- a/guides/manual/7-builders.md +++ b/guides/manual/7-builders.md @@ -4,6 +4,8 @@ ## Builders +
+ | | | | -- | -- | | [← Field Schemas](./6-schemas.md)                        |                                                         |