Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add about and getting started docs #2838

Draft
wants to merge 4 commits into
base: develop
Choose a base branch
from
Draft
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
23 changes: 23 additions & 0 deletions docs/guides/introduction/about.md
Original file line number Diff line number Diff line change
@@ -1 +1,24 @@
# About Daffodil

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Daffodil is a client-side framework for building ecommerce stores. It presents a standard set of interfaces with which the frontend application can interact along with a selection of drivers that communicate with the platform of choice.

## Objectives
Daffodil aims to:
- Provide a strongly-typed set of libraries and component kit to simplify ecommerce store development
- Ease migration between ecommerce platforms by decoupling frontend code from the current platform's API
- Provide a collection of features a-la carte style such that no unused features are unnecessarily imported
- Allow extension and customization such that business-specific features can be supported in a platform-agnostic way

<!--- TODO: add link to longer motivations explanation --->

## Architecture
The most common type of Daffodil package has a number of layers that can be visualized like so:
```mermaid
flowchart TD
A[Routing] --> B[State]
B --> C{Driver Interfaces}
D[Platform Drivers] --> C
C --> E[Models]
```
Each of these layers exists as a subpackage of the corresponding feature module, e.g. `@daffodil/cart/state`.
<!--- TODO: add link to longer architecture explanation --->
28 changes: 28 additions & 0 deletions docs/guides/introduction/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# Getting Started
## Installation
Daffodil packages are provided a la carte. Each package provides a particular feature and must be installed separately. The following example demonstrates how to install the product package with `npm`.

```sh
npm install --save @daffodil/product
```

## Usage
The first step is to choose a driver that corresponds to the platform of choice. Daffodil provides lightweight in-memory API drivers to mock out a test platform for rapid frontend development.
<!--- TODO: add link to in-memory explanation --->
Once a platform has been chosen, import the corresponding driver module:

```ts
import {DaffProductInMemoryDriverModule} from '@daffodil/product/driver/in-memory'

@NgModule({
imports: [
DaffProductInMemoryDriverModule.forRoot()
]
})
class AppModule {}
```

Interacting with a given platform through Daffodil can be done in a couple of ways. The simplest, and recommended, way is through state.

### State
Interaction with the platform is done by dispatching actions and reading data from facades. Daffodil state packages track the loading state of each operation and store the results and/or errors in redux state.

<!--- TODO: add link to simple state example --->
Loading