Skip to content

Commit 3523a37

Browse files
committed
docs: further optimizations
1 parent 57d3697 commit 3523a37

File tree

3 files changed

+15
-13
lines changed

3 files changed

+15
-13
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,11 @@ DB UI Core provides robust HTML UI components, reusable visual styles, and power
3030

3131
## <abbr title="too long; didn't read">tl;dr</abbr>: "too long" Danny replied
3232

33-
- [Getting started](docs/getStarted.adoc)
34-
- [GitHub - DB UI Core](https://github.com/db-ui/core/)
35-
- [Hosted version of DB UI Core living styleguide](https://db.de/db-ui)
36-
- [Migrating guide from version 1 of DB UI Core to version 2](docs/migrationGuide.adoc#user-content-db-ui-core-2-0-0-migration-guide)
33+
- [Getting started](docs/getStarted.adoc)
34+
- [GitHub - DB UI Core](https://github.com/db-ui/core/)
35+
- [Hosted version of DB UI Core living styleguide](https://db.de/db-ui)
36+
- Recommended for JavaScript application development: [DB UI Elements](https://db-ui.github.io/elements/)
37+
- [Migrating guide from version 1 of DB UI Core to version 2](docs/migrationGuide.adoc#user-content-db-ui-core-2-0-0-migration-guide)
3738

3839
## Core principals
3940

@@ -61,12 +62,12 @@ As [DB Design System](https://marketingportal.extranet.deutschebahn.com/de/ui-ko
6162

6263
Additionally we'll provide some more information over time regrading the whole ecosystem:
6364

64-
- [DB Design System UX Guides + Standards documentation within the DB Marketingportal (german)](https://marketingportal.extranet.deutschebahn.com/de/ui-komponenten)
65-
- [Confluence / Base Wiki - "Technische Umsetzung des Enterprise UI Design Systems" (german, only available internally)](https://db.de/pu8moh)
66-
- [Confluence - Web UI Component Library (only available internally)](https://db.de/1tyr73)
67-
- [Changelog](https://github.com/db-ui/core/blob/main/CHANGELOG.md)
68-
- [Architectural Decision Records](https://github.com/db-ui/core/tree/main/docs/adr)
69-
- [DB UI Core 1.x Gitlab repository (only accessible internally)](https://db.de/4cwtyn/)
65+
- [DB Design System UX Guides + Standards documentation within the DB Marketingportal (german)](https://marketingportal.extranet.deutschebahn.com/de/ui-komponenten)
66+
- [Confluence / Base Wiki - "Technische Umsetzung des Enterprise UI Design Systems" (german, only available internally)](https://db.de/pu8moh)
67+
- [Confluence - Web UI Component Library (only available internally)](https://db.de/1tyr73)
68+
- [Changelog](https://github.com/db-ui/core/blob/main/CHANGELOG.md)
69+
- [Architectural Decision Records](https://github.com/db-ui/core/tree/main/docs/adr)
70+
- [DB UI Core 1.x Gitlab repository (only accessible internally)](https://db.de/4cwtyn/)
7071

7172
## Things to keep in mind
7273

docs/getStarted.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Get started as Application Developer
1+
# Getting started as a Web Developer
22

33
## Purpose
44

5-
You are an Application Developer and you want to use DB UI Core in your own application.
5+
You're a Web Developer and you want to use DB UI Core in your own application. Especially for JavaScript application development, we're recommending to have a look at link:https://db-ui.github.io/elements/[DB UI Elements] instead.
66

77
## Options
88

source/_patterns/04-pages/intro.hbs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
<section>
3535
{{> elements-headline type='2' text='How to use' }}
3636
<p>For using DB UI Core, you need to install it as a dependency to your project and then link it within your HTML / CSS.<br>
37-
Please have a look into the <a href='https://github.com/db-ui/core/tree/main/docs/getStarted.adoc' target='_blank' rel='noopener noreferrer'>Docs / Get Started(docs)</a> for detailed instructions.</p>
37+
Please have a look into the <a href='https://github.com/db-ui/core/tree/main/docs/getStarted.adoc' target='_blank' rel='noopener noreferrer'>Docs / Get Started(docs)</a> for detailed instructions.<br>
38+
In case that you're developing a JavaScript application, please have a look at <a href="https://db-ui.github.io/elements/">DB UI Elements</a>, that's based on DB UI Core and provides Web Components for easier integration into this tech context.</p>
3839

3940
{{> elements-headline type='2' text='More information' }}
4041
<p>Additionally we'll provide some more information over time regrading the whole ecosystem:

0 commit comments

Comments
 (0)