docs(improve docs): add some missing parts (DSP-1752) (#308)

* docs(design docs): add a section about MatDatepicker * docs(getting started): add missing fields in config
dasch-swiss · Jun 22, 2021 · bed8a20 · bed8a20
1 parent 91bb637
commit bed8a20
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/docs/how-to-contribute/design-documentation.md b/docs/how-to-contribute/design-documentation.md
@@ -157,21 +157,26 @@ The value component's selector is chosen from `valueTypeOrClass`. Since all valu
 Value components may have additional specific inputs for configuration that can be handled in `DisplayEditComponent`'s template as well
 ,e.g., additional configuration of how do display a date.
 
-#### Integration of CKEditor
+### Integration of CKEditor
 
-### General Setup
+#### General Setup
 
 To edit XML, the viewer module relies on CKEditor. `TextValueAsXMLComponent` integrates the CKEditor library for Angular.
 In addition, a custom build of CKEditor is needed which is accessible on [GitHub](https://github.com/dasch-swiss/ckeditor_custom_build).
 To make a new custom build, follow the [instructions](https://github.com/dasch-swiss/ckeditor_custom_build/blob/master/how-to-build.md).
 
 Note that currently only the standard mapping is supported.
 
-### Handling Internal Links When Displaying Text
+#### Handling Internal Links When Displaying Text
 
 When a text created with CKEditor is shown in read-mode, click and hover events on internal links can be reacted to by applying the directive `TextValueHtmlLinkDirective` with the selector `dspHtmlLink`.
 Internal links have the class "salsah-link".
 
+### Integration of the MatDatepicker
+
+The `MatDatepicker` cannot be used as part of the CRUD UI components due to its limitations in terms of precision and era selection.
+As a replacement, `DateInputTextComponent` is being used allowing for year, month, and day precision and era selection.
+
 ## Search Module
 
 The search module allows different ways of searching in order to make simple or complex searches in DSP-API.

diff --git a/docs/how-to-use/getting-started.md b/docs/how-to-use/getting-started.md
@@ -37,7 +37,9 @@ In your Angular project, create the file `config.dev.json` inside `src/config/`:
   "apiPort": 3333,
   "apiPath": "",
   "jsonWebToken": "",
-  "logErrors": true
+  "logErrors": true,
+  "sipiUrl": "http://0.0.0.0:1024/",
+  "geonameToken": "token"
 }
 ```