Skip to content

Commit

Permalink
docs: moved specs to antora (#222)
Browse files Browse the repository at this point in the history
* docs: moved docs to antora

* docs: fixed image paths

* chore: typo
  • Loading branch information
lem-onade authored May 20, 2021
1 parent 55e384e commit 3d84952
Show file tree
Hide file tree
Showing 26 changed files with 52 additions and 12 deletions.
1 change: 1 addition & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ version: 0.2.1
nav:
- modules/ROOT/nav.adoc
- modules/manual/nav.adoc
- modules/specs/nav.adoc
12 changes: 12 additions & 0 deletions docs/modules/specs/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
ifdef::env-github,env-browser[:relfilesuffix: .adoc]
ifdef::env-github,env-browser[:relfileprefix: pages/]

* xref:set-up-authenticate-feature.adoc[Set up authenticate feature]
* xref:create-authenticate-login-page.adoc[Create authenticate login page]
* xref:set-up-collection-feature.adoc[Set up collection feature]
* xref:create-collection-overview-page.adoc[Create collection overview page]
* xref:create-content-header-component.adoc[Create content header component]
* xref:create-object-card-component.adoc[Create object card component]
* xref:create-sidebar-list-item-component.adoc[Create sidebar list item component]
* xref:add-svg-icons.adoc[Add SVG icons]
* xref:create-solid-store.adoc[Create solid store]
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= Technical Documentation: Add svg icons
:sectanchors:
:url-repo: https://github.com/digita-ai/nde-erfgoedinstellingen
:imagesdir: ../images

== Author(s)

Expand Down Expand Up @@ -32,8 +35,8 @@ All changes are to be made in the '@digita-ai/nde-erfgoed-theme' package.

The finished icons should look like this:

image::../../assets/collections/icons-1.svg[Icons]
image::../../assets/collections/icons-2.svg[Icons]
image::../images/collections/icons-1.svg[Icons]
image::../images/collections/icons-2.svg[Icons]


Create in '@digita-ai/nde-erfgoed-theme' package under 'lib/icon/'.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= Technical Documentation: Create authenticate login page
:sectanchors:
:url-repo: https://github.com/digita-ai/nde-erfgoedinstellingen
:imagesdir: ../images

== Author(s)

Expand Down Expand Up @@ -47,7 +50,7 @@ In 'nde-erfgoed-manage', register their HTML tags in app.ts.

The finished component should look like this:

image::../../assets/authenticate/button.svg[ButtonComponent]
image::../images/authenticate/button.svg[ButtonComponent]

Generate in '@digita-ai/nde-erfgoed-components' package under 'lib/common/button/button.component.ts', with tag `<nde-button>`

Expand Down Expand Up @@ -75,7 +78,7 @@ Example usage of a button with both icons set:

The finished component should look like this:

image::../../assets/authenticate/authenticate-login-page.svg[AuthenticateLoginPageComponent]
image::../images/authenticate/authenticate-login-page.svg[AuthenticateLoginPageComponent]

Generate under 'lib/features/authenticate/pages/authenticate-login-page.component.ts' with tag `<nde-authenticate-login-page>`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= Technical Documentation: Create collection overview page
:sectanchors:
:url-repo: https://github.com/digita-ai/nde-erfgoedinstellingen
:imagesdir: ../images

== Author(s)

Expand Down Expand Up @@ -35,15 +38,15 @@ The shared components needed for this spec are created.

The finished component should look like this:

image::../../assets/collections/collection-root.svg[CollectionRootComponent]
image::../images/collections/collection-root.svg[CollectionRootComponent]

Create in '@digita-ai/nde-erfgoed-manage' package under 'lib/collections/pages/collection-root.component'. (might already exist)

The component contains a `ContentHeaderComponent` at the top, followed by a https://css-tricks.com/snippets/css/complete-guide-grid/[grid] of `ObjectCardComponents`. The header contains the title and description of the current component. These should be made so that, when the edit action icon is clicked, they can be edited with input fields. The value of these input fields can be saved by clicked the save action on the right, which replaces the edit icon. When editing (`CollectionsState.EDITING`), a new cancel icon is shown as well, to leave the editing state. The other two action icons in the header, create and delete, should fire the `CollectionEvents.CLICKED_CREATE_OBJECT` and `CollectionEvents.CLICKED_DELETE` events, respectively.

Every `CollectionObject` in the current `Collection` should be displayed using a grid of `ObjectCardComponents`. Clicking these should not do anything, yet. Try to adjust the grid dimensions based on window width. With default view widths, three cards should be displayed next to eachother.

image::../../assets/collections/collection-root-no-objects.svg[CollectionRootComponent without CollectionObjects]
image::../images/collections/collection-root-no-objects.svg[CollectionRootComponent without CollectionObjects]

If the component does not contain any `CollectionObjects`, the page should display a large icon. (see image)
The svg for this icon can be found on Figma, export it and add it to the theme package.
Expand All @@ -53,7 +56,7 @@ The svg for this icon can be found on Figma, export it and add it to the theme p

The finished component should look like this:

image::../../assets/collections/app-root.svg[AppRootComponent]
image::../images/collections/app-root.svg[AppRootComponent]

Exists in '@digita-ai/nde-erfgoed-manage' package under 'lib/'.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= Technical Documentation: Create content header
:sectanchors:
:url-repo: https://github.com/digita-ai/nde-erfgoedinstellingen
:imagesdir: ../images

== Author(s)

Expand Down Expand Up @@ -32,7 +35,7 @@ All components are to be made in the '@digita-ai/nde-erfgoed-components' package

The finished component should look like this:

image::../../assets/collections/content-header.svg[ContentHeaderComponent]
image::../images/collections/content-header.svg[ContentHeaderComponent]


Generate in '@digita-ai/nde-erfgoed-components' package under 'lib/header/content-header.component.ts', with tag `<nde-content-header>`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= Technical Documentation: Create object card component
:sectanchors:
:url-repo: https://github.com/digita-ai/nde-erfgoedinstellingen
:imagesdir: ../images

== Author(s)

Expand Down Expand Up @@ -63,7 +66,7 @@ Create 'collection-object.ts' under 'lib/collections/' in the 'nde-erfgoed-core'

The finished component should look like this:

image::../../assets/collections/collection-object-component.svg[ObjectCardComponent]
image::../images/collections/collection-object-component.svg[ObjectCardComponent]

Generate in '@digita-ai/nde-erfgoed-components' package under 'lib/collection-object/object-card.component.ts', with tag `<nde-object-card>`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= Technical Documentation: Update sidebar
:sectanchors:
:url-repo: https://github.com/digita-ai/nde-erfgoedinstellingen
:imagesdir: ../images

== Author(s)

Expand Down Expand Up @@ -32,7 +35,7 @@ All components are to be made in the '@digita-ai/nde-erfgoed-components' package

The finished component should look like this:

image::../../assets/collections/sidebar-list-item.svg[SidebarListItemComponent]
image::../images/collections/sidebar-list-item.svg[SidebarListItemComponent]


Generate in '@digita-ai/nde-erfgoed-components' package under 'lib/sidebar/sidebar-list-item.component.ts', with tag `<nde-sidebar-list-item>`
Expand All @@ -49,7 +52,7 @@ To preview the component while developing: register the component in 'lib/demo.t

The finished component should look like this:

image::../../assets/collections/sidebar-list.svg[SidebarItemComponent]
image::../images/collections/sidebar-list.svg[SidebarItemComponent]


Generate in '@digita-ai/nde-erfgoed-components' package under 'lib/sidebar/sidebar-item.component.ts', with tag `<nde-sidebar-item>`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= Technical Documentation: Create Solid store
:sectanchors:
:url-repo: https://github.com/digita-ai/nde-erfgoedinstellingen
:imagesdir: ../images

== Author(s)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= Technical Documentation: Set up authenticate feature
:sectanchors:
:url-repo: https://github.com/digita-ai/nde-erfgoedinstellingen
:imagesdir: ../images

== Author(s)

Expand Down Expand Up @@ -56,7 +59,7 @@ The `authenticateConfig` has three possible states:
* `AuthenticateStates.AUTHENTICATING`
* `AuthenticateStates.AUTHENTICATED`

image::../../assets/authenticate/authenticate-machine-state-chart.svg[AuthenticateMachine State Chart]
image::../images/authenticate/authenticate-machine-state-chart.svg[AuthenticateMachine State Chart]

The `AuthenticateStates.UNAUTHENTICATED` state is the initial state of the machine. From here, it can transition to the `AuthenticateStates.AUTHENTICATING` state when the `AuthenticateEvents.CLICKED_LOGIN` event is called. The machine should be in the `AuthenticateStates.AUTHENTICATING` state from the moment the button is clicked. The app should transition to `AuthenticateStates.AUTHENTICATED` using the `AuthenticateEvents.LOGIN_SUCCESS` event when the `handleIncomingRedirect()` function is called and its return value contains a `isLoggedIn` attribute equal to `true`. Should `isLoggedIn` be `false`, a `AuthenticateEvents.LOGIN_ERROR` event should be dispatched and the machine should return to its initial state. After `AuthenticateEvents.LOGIN_SUCCESS`, we reach the `AuthenticateStates.AUTHENTICATED` state. From this state, the machine can go back to the `AuthenticateStates.UNAUTHENTICATED` state when a `AuthenticateEvents.CLICKED_LOGOUT` action is fired.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= Technical Documentation: Set up collection feature
:sectanchors:
:url-repo: https://github.com/digita-ai/nde-erfgoedinstellingen
:imagesdir: ../images

== Author(s)

Expand Down

0 comments on commit 3d84952

Please sign in to comment.