From 3395e7f0bc41d395ac6456bdd9b0dc77eae87461 Mon Sep 17 00:00:00 2001 From: sercan Date: Sat, 15 May 2021 13:44:13 +0300 Subject: [PATCH] (docs) Updated docs --- .../components/drawer/drawer.component.html | 2 +- .../components/navigation/navigation.component.html | 2 +- .../libraries/mock-api/mock-api.component.html | 6 +++--- .../customization/splash-screen/splash-screen.html | 2 +- .../customization/theme-layouts/theme-layouts.html | 2 +- .../docs/guides/customization/theming/theming.html | 2 +- .../component-structure/component-structure.html | 2 +- .../guides/development/deployment/deployment.html | 12 +++++++----- .../directory-structure/directory-structure.html | 8 +------- .../getting-started/installation/installation.html | 4 ++-- .../docs/guides/getting-started/serving/serving.html | 7 ++++--- .../common/overview/overview.component.html | 4 ++-- .../docs/other-components/other-components.module.ts | 2 ++ 13 files changed, 27 insertions(+), 28 deletions(-) diff --git a/src/app/modules/admin/docs/core-features/components/drawer/drawer.component.html b/src/app/modules/admin/docs/core-features/components/drawer/drawer.component.html index 79033040..7590fc49 100644 --- a/src/app/modules/admin/docs/core-features/components/drawer/drawer.component.html +++ b/src/app/modules/admin/docs/core-features/components/drawer/drawer.component.html @@ -44,7 +44,7 @@ mat-drawer.

Since fuse-drawer works with absolute positioning by default, the parent of the drawer must have position: relative and overflow-x: hidden properties otherwise the drawer won't be able to work correctly. diff --git a/src/app/modules/admin/docs/core-features/components/navigation/navigation.component.html b/src/app/modules/admin/docs/core-features/components/navigation/navigation.component.html index 23abf861..7dc0cfbf 100644 --- a/src/app/modules/admin/docs/core-features/components/navigation/navigation.component.html +++ b/src/app/modules/admin/docs/core-features/components/navigation/navigation.component.html @@ -55,7 +55,7 @@

fuse-navigation designed to work with data and it must be supplied in certain format. If you want to create a navigation from an HTML structure, this component is not for you. diff --git a/src/app/modules/admin/docs/core-features/libraries/mock-api/mock-api.component.html b/src/app/modules/admin/docs/core-features/libraries/mock-api/mock-api.component.html index de949a3e..85805a8b 100644 --- a/src/app/modules/admin/docs/core-features/libraries/mock-api/mock-api.component.html +++ b/src/app/modules/admin/docs/core-features/libraries/mock-api/mock-api.component.html @@ -57,7 +57,7 @@
  • If you need to present your idea to your client or to your boss without spending many hours and resources
    • MockAPI is NOT a database or a backend replacement! It works on memory. As soon as you reload your app, all the changes you have made using Mock API endpoints will go away and replaced with defaults. @@ -200,7 +200,7 @@ mechanic, you will be able to mock API endpoints in no time.

    Please keep in mind that the following step-by-step guide assumes you are doing everything from scratch for the MockAPI like creating directories, adding files, exporting via barrels etc. Majority of these already setup in both Demo and Starter apps for you so it's a bit easier to start working with the @@ -213,7 +213,7 @@ For this guide, we will assume you are going to use the default directory.

    It's important to keep all mock related files in the same directory because we will create a barrel file that exports all the mock classes and provide that to the FuseMockApiModule so it can register and use them. diff --git a/src/app/modules/admin/docs/guides/customization/splash-screen/splash-screen.html b/src/app/modules/admin/docs/guides/customization/splash-screen/splash-screen.html index ce19dc39..ef9b9e06 100644 --- a/src/app/modules/admin/docs/guides/customization/splash-screen/splash-screen.html +++ b/src/app/modules/admin/docs/guides/customization/splash-screen/splash-screen.html @@ -70,7 +70,7 @@ page.

    Please note, you cannot run Angular components in here. Basically, by the time you can run Angular components, you won't be needing the splash screen because everything would already be loaded! diff --git a/src/app/modules/admin/docs/guides/customization/theme-layouts/theme-layouts.html b/src/app/modules/admin/docs/guides/customization/theme-layouts/theme-layouts.html index e5c2fecb..61f9f2a8 100644 --- a/src/app/modules/admin/docs/guides/customization/theme-layouts/theme-layouts.html +++ b/src/app/modules/admin/docs/guides/customization/theme-layouts/theme-layouts.html @@ -48,7 +48,7 @@ made configuration service to store, write and read application wide configurations.

    More detailed information about FuseConfigService can be found in the Core features > Services > diff --git a/src/app/modules/admin/docs/guides/customization/theming/theming.html b/src/app/modules/admin/docs/guides/customization/theming/theming.html index 0193acea..0af026e6 100644 --- a/src/app/modules/admin/docs/guides/customization/theming/theming.html +++ b/src/app/modules/admin/docs/guides/customization/theming/theming.html @@ -141,7 +141,7 @@

    diff --git a/src/app/modules/admin/docs/guides/development/component-structure/component-structure.html b/src/app/modules/admin/docs/guides/development/component-structure/component-structure.html index b11b5857..4b96d15b 100644 --- a/src/app/modules/admin/docs/guides/development/component-structure/component-structure.html +++ b/src/app/modules/admin/docs/guides/development/component-structure/component-structure.html @@ -39,7 +39,7 @@

    Fuse uses route based component loading strategy. There are componentless and empty-path routes specifically structured to load components without hard diff --git a/src/app/modules/admin/docs/guides/development/deployment/deployment.html b/src/app/modules/admin/docs/guides/development/deployment/deployment.html index 93cd0c45..4d1af7d0 100644 --- a/src/app/modules/admin/docs/guides/development/deployment/deployment.html +++ b/src/app/modules/admin/docs/guides/development/deployment/deployment.html @@ -48,24 +48,26 @@

    Alternate command

    - Alias for ng build --prod. + Alias for ng build.

    -

    + If you are getting error messages that includes keywords like HEAP, JS stack tree, out of memory while trying to run ng build --prod or npm run build:prod commands, you may have an older Node.js version, try updating your Node.js to the latest LTS version and then try again. -

    +
    diff --git a/src/app/modules/admin/docs/guides/development/directory-structure/directory-structure.html b/src/app/modules/admin/docs/guides/development/directory-structure/directory-structure.html index 3b976cbf..32281f41 100644 --- a/src/app/modules/admin/docs/guides/development/directory-structure/directory-structure.html +++ b/src/app/modules/admin/docs/guides/development/directory-structure/directory-structure.html @@ -39,7 +39,7 @@
    Fuse's directory structure might look overwhelming and intimidating at first, but following this page and giving a bit time to understand it before jumping right into code will help immensely. @@ -198,12 +198,6 @@ Core features > Libraries > MockAPI section of this documentation.

    - - Starter - version of Fuse doesn't include any mock-api services except for the Navigation. -

    app/layout/

    diff --git a/src/app/modules/admin/docs/guides/getting-started/installation/installation.html b/src/app/modules/admin/docs/guides/getting-started/installation/installation.html index 01f12353..fec2c653 100644 --- a/src/app/modules/admin/docs/guides/getting-started/installation/installation.html +++ b/src/app/modules/admin/docs/guides/getting-started/installation/installation.html @@ -77,7 +77,7 @@ After choosing the version you want to install, unzip the .zip file of that version into your workspace directory.

    @@ -107,7 +107,7 @@ This command will take some time and install all the required libraries into the node_modules directory in order for you to start developing.

    diff --git a/src/app/modules/admin/docs/guides/getting-started/serving/serving.html b/src/app/modules/admin/docs/guides/getting-started/serving/serving.html index 94479a6f..bf753db9 100644 --- a/src/app/modules/admin/docs/guides/getting-started/serving/serving.html +++ b/src/app/modules/admin/docs/guides/getting-started/serving/serving.html @@ -38,7 +38,6 @@

    -

    After the installation process finishes, run the following command while still in your workspace directory:

    @@ -64,11 +63,13 @@ Alias for ng serve --open.

    -

    + If you are getting error messages that includes keywords like HEAP, JS stack tree, out of memory while trying to run ng serve --open or npm start commands, you may have an older Node.js version, try updating your Node.js to the latest LTS version and then try again. -

    +
    diff --git a/src/app/modules/admin/docs/other-components/common/overview/overview.component.html b/src/app/modules/admin/docs/other-components/common/overview/overview.component.html index 045af4c2..8c6488e1 100644 --- a/src/app/modules/admin/docs/other-components/common/overview/overview.component.html +++ b/src/app/modules/admin/docs/other-components/common/overview/overview.component.html @@ -43,14 +43,14 @@ therefore they are located in the src/app/layout/common/ directory. You can modify them without touching the @fuse directory.

    These components are not very complex and they only provide some basic features. If you wish them to do more, you have to customize them, and that's exactly why they are not located in the @fuse directory like other components. We may add more features and more custom components in the future if they will be beneficial for everyone. Components that are too specific to a project won't be included as custom components into Fuse! diff --git a/src/app/modules/admin/docs/other-components/other-components.module.ts b/src/app/modules/admin/docs/other-components/other-components.module.ts index 35444dab..b6d4cca1 100644 --- a/src/app/modules/admin/docs/other-components/other-components.module.ts +++ b/src/app/modules/admin/docs/other-components/other-components.module.ts @@ -1,5 +1,6 @@ import { NgModule } from '@angular/core'; import { RouterModule } from '@angular/router'; +import { MatButtonModule } from '@angular/material/button'; import { MatIconModule } from '@angular/material/icon'; import { MatSidenavModule } from '@angular/material/sidenav'; import { FuseHighlightModule } from '@fuse/components/highlight'; @@ -36,6 +37,7 @@ import { otherComponentsRoutes } from 'app/modules/admin/docs/other-components/o ], imports : [ RouterModule.forChild(otherComponentsRoutes), + MatButtonModule, MatIconModule, MatSidenavModule, FuseHighlightModule,