From a60d70c7694fb8a4ff068711410cf64933d847df Mon Sep 17 00:00:00 2001 From: Elain T Date: Fri, 7 Jun 2024 09:48:57 -0600 Subject: [PATCH] feat(docs): reorganize docs folder (#2834) --- docs/CHANGELOG.md => CHANGELOG.md | 0 docs/INSTALLATION.md | 59 ------------------------------- docs/MAINTAINER.md | 7 ---- docs/{ => internal}/DEVELOPER.md | 18 +++++----- docs/{ => internal}/RELEASE.MD | 0 docs/{ => internal}/styles.md | 1 - 6 files changed, 9 insertions(+), 76 deletions(-) rename docs/CHANGELOG.md => CHANGELOG.md (100%) delete mode 100644 docs/INSTALLATION.md delete mode 100644 docs/MAINTAINER.md rename docs/{ => internal}/DEVELOPER.md (81%) rename docs/{ => internal}/RELEASE.MD (100%) rename docs/{ => internal}/styles.md (99%) diff --git a/docs/CHANGELOG.md b/CHANGELOG.md similarity index 100% rename from docs/CHANGELOG.md rename to CHANGELOG.md diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md deleted file mode 100644 index f8784ed9d5..0000000000 --- a/docs/INSTALLATION.md +++ /dev/null @@ -1,59 +0,0 @@ -# Installation -This will walk you through a simple setup of the `@daffodil` packages. - -> Please note that as of now, we don't provide any pre-built store application pages. We do provide the `@daffodil/design` component kit, and many examples in `@daffodil/demo`, but, out-of-the-box, you won't see much different than a default Angular installation. - -## Prerequisites - -1. [Node v8+](https://nodejs.org/en/) -2. [Angular CLI](https://cli.angular.io/) - -## Set Up Your Angular Project - -```bash -ng new my-store && cd my-store -``` - -## Install the @daffodil packages - -1. Install Daffodil Modules You Need - * `npm install --save @daffodil/product` - Install Product Module - * `npm install --save @daffodil/cart` - Install Cart Module - * `npm install --save @daffodil/checkout` - Install Checkout Module - * `npm install --save @daffodil/newsletter` - Install Newsletter Module - - -## Install Peer Dependencies - -```bash -npm install --save @daffodil/core @daffodil/driver @ngrx/store @ngrx/effects @ngrx/entity -``` - -## Configure Your App -Add the following to your new application's root `AppModule`. - -> Be sure to replace the default `YOUR_STORE_URL_GOES_HERE` with your store's url in your `AppModule`. - -```ts -@NgModule({ - ... - imports: [ - ... - StoreModule.forRoot({}), - EffectsModule.forRoot([]), - DaffodilModule.forRoot({BASE_URL: "YOUR_STORE_URL_GOES_HERE"}), - ... - ], - ... -}) -export class AppModule { } -``` - -## Serve the App -Serving the app should be very familiar if you've ever worked with Angular. It should be as simple as: - -1. `ng serve` -2. Visit http://localhost:4200 in your browser - -## Next Steps -[Check out Daffodil's demo store](https://github.com/graycoreio/daffodil/tree/develop/apps/demo) for code examples. \ No newline at end of file diff --git a/docs/MAINTAINER.md b/docs/MAINTAINER.md deleted file mode 100644 index 1a1f1461f1..0000000000 --- a/docs/MAINTAINER.md +++ /dev/null @@ -1,7 +0,0 @@ -# Maintainer Documentation - -The docs are intended to be used by the core `@daffodil` team to record common process. - -## Release - -After updating the version and navigating to the dist folder, run `npm publish` to publish the current version of @daffodil/product, @daffodil/cart, and @daffodil/checkout to npm. diff --git a/docs/DEVELOPER.md b/docs/internal/DEVELOPER.md similarity index 81% rename from docs/DEVELOPER.md rename to docs/internal/DEVELOPER.md index 6ef2aae1d0..3775e34a15 100644 --- a/docs/DEVELOPER.md +++ b/docs/internal/DEVELOPER.md @@ -73,14 +73,14 @@ ng test appName You can read more about each library and it's build/testing process in the readme of the relevant library or app. ### Apps -* [daff.io](../apps/daffio/README.md) -* [demo](../apps/daffio/README.md) -* [design-land](../apps/design-land/README.md) +* [daff.io](../../apps/daffio/README.md) +* [demo](../../apps/daffio/README.md) +* [design-land](../../apps/design-land/README.md) ### Libraries -* [core](../libs/core/README.md) -* [checkout](../libs/checkout/README.md) -* [cart](../libs/cart/README.md) -* [drivers](../libs/drivers/README.md) -* [design](../libs/design/README.md) -* [product](../libs/product/README.md) \ No newline at end of file +* [core](../../libs/core/README.md) +* [checkout](../../libs/checkout/README.md) +* [cart](../../libs/cart/README.md) +* [drivers](../../libs/drivers/README.md) +* [design](../../libs/design/README.md) +* [product](../../libs/product/README.md) \ No newline at end of file diff --git a/docs/RELEASE.MD b/docs/internal/RELEASE.MD similarity index 100% rename from docs/RELEASE.MD rename to docs/internal/RELEASE.MD diff --git a/docs/styles.md b/docs/internal/styles.md similarity index 99% rename from docs/styles.md rename to docs/internal/styles.md index c2430ed2bd..cb16ea4bbb 100644 --- a/docs/styles.md +++ b/docs/internal/styles.md @@ -1,3 +1,2 @@ - ## Child Component outer Padding/Margin Child components should not define their own outer padding or margin. This is to ensure the component can be reused in other parts of an app. The parent component should define the padding and margin between its child components. \ No newline at end of file