Skip to content

Commit

Permalink
chore: give sections breathing room
Browse files Browse the repository at this point in the history
  • Loading branch information
runspired committed Nov 12, 2024
1 parent e6c64e3 commit 68c1ef5
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ rich application — letting you ship better experiences more quickly withou
- [Team](https://emberjs.com/team)
- [Blog](https://emberjs.com/blog)

<br>

## Installation

```sh
Expand All @@ -75,6 +77,8 @@ pnpm add ember-data
> is currently being worked on for the Polaris experience and will
> be available soon.
<br>

## Compatibility

The following table lists WarpDrive/EmberData versions alongside information about
Expand All @@ -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

<br>

## The Big List of Versions

| Package | Audience | LTS-4-12 | LTS | Stable | Beta | Canary |
Expand Down Expand Up @@ -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) |

<br>

## 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.

<br>

### License

This project is licensed under the [MIT License](LICENSE.md).
4 changes: 4 additions & 0 deletions guides/manual/1-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<br>

## Why WarpDrive?

WarpDrive is the data framework for building ambitious applications.
Expand All @@ -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.

<br>

| | |
| -- | -- |
| [← Table of Contents](./0-index.md#table-of-contents) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Making Requests →](./2-requests.md) |
6 changes: 6 additions & 0 deletions guides/manual/2-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<br>

### Fetch Example

> [!TIP]
Expand Down Expand Up @@ -73,6 +75,8 @@ const { content } = await manager.request<UsersQuery>({ url: '/users' });
> to type a request, look for the section on [builders](./7-builders.md)
> later.
<br>

### 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:
Expand Down Expand Up @@ -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)
<br>
| | |
| -- | -- |
| [← Introduction](./1-overview.md) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Key Data Structures →](./3-data.md) |
2 changes: 2 additions & 0 deletions guides/manual/3-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<br>

| | |
| -- | -- |
| [← Making Requests](./2-requests.md) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Caching →](./4-caching.md) |
12 changes: 12 additions & 0 deletions guides/manual/4-caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,28 @@

## Caching

<br>

### CacheHandler

<br>

### CachePolicy

<br>

### In-Memory Cache

<br>

### Cache Eviction

<br>

### Persisted Caching

<br>

| | |
| -- | -- |
| [← Key Data Structures](./3-data.md) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Working with Data in your UI →](./5-presentation.md) |
2 changes: 2 additions & 0 deletions guides/manual/5-presentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## Working with Data in your UI

<br>

| | |
| -- | -- |
| [← Caching](./4-caching.md) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Field Schemas →](./6-schemas.md) |
2 changes: 2 additions & 0 deletions guides/manual/6-schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## Field Schemas

<br>

| | |
| -- | -- |
| [← Working with Data in your UI](./5-presentation.md) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Request Builders →](./7-builders.md) |
2 changes: 2 additions & 0 deletions guides/manual/7-builders.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## Builders

<br>

| | |
| -- | -- |
| [← Field Schemas](./6-schemas.md) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |

0 comments on commit 68c1ef5

Please sign in to comment.