Skip to content

Commit 83f8e65

Browse files
author
Lieven Van Gestel
committed
chore(documentation): clean up README files of parent modules
1 parent 9dfdab5 commit 83f8e65

File tree

3 files changed

+4
-40
lines changed

3 files changed

+4
-40
lines changed

packages/forms/README.md

+2-15
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,13 @@
11
# @acpaas-ui/ngx-components/forms
22

33
The forms module is a collection of several forms-related modules, like an autocomplete, a datepicker, a mask, a range slider, a timepicker, etc.
4-
5-
## Usage
6-
7-
```typescript
8-
import {
9-
AutoCompleteModule,
10-
DatepickerModule,
11-
MaskModule,
12-
RangeSliderModule,
13-
TimepickerModule,
14-
UploadModule,
15-
WysiwygModule,
16-
} from '@acpaas-ui/ngx-components/forms'`;
17-
```
4+
You can find an overview in the [Modules](#modules) section below.
185

196
## Documentation
207

218
Visit our [documentation site](https://acpaas-ui.digipolis.be/) for full how-to docs and guidelines
229

23-
## Modules
10+
## <a name="modules"></a>Modules
2411

2512
| Name | Description | Documentation |
2613
| ----------- | ------ | -------------------------- |

packages/layout/README.md

+2-15
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,13 @@
11
# @acpaas-ui/ngx-components/layout
22

33
The layout module is a collection of several layout-related modules, like a header, a footer, a modal, a pane, etc.
4-
5-
## Usage
6-
7-
```typescript
8-
import {
9-
CookieconsentModule,
10-
FooterModule,
11-
HeaderModule,
12-
HeroModule,
13-
ModalModule,
14-
PaneModule,
15-
SidebarModule
16-
} from '@acpaas-ui/ngx-components/layout'`;
17-
```
4+
You can find an overview in the [Modules](#modules) section below.
185

196
## Documentation
207

218
Visit our [documentation site](https://acpaas-ui.digipolis.be/) for full how-to docs and guidelines
229

23-
## Modules
10+
## <a name="modules"></a>Modules
2411

2512
| Name | Description | Documentation |
2613
| ----------- | ------ | -------------------------- |

packages/utils/README.md

-10
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,6 @@
33
The utils module is a collection of some frequently used utility modules like a filter, labels or window module. So you don't need to reinvent the wheel every time.
44
You can find an overview in the [Modules](#modules) section below.
55

6-
## Usage
7-
8-
```typescript
9-
import {
10-
FilterModule,
11-
LabelsModule,
12-
WindowModule
13-
} from '@acpaas-ui/ngx-components/utils'`;
14-
```
15-
166
## Documentation
177

188
Visit our [documentation site](https://acpaas-ui.digipolis.be/) for full how-to docs and guidelines

0 commit comments

Comments
 (0)