Skip to content

Commit

Permalink
docs: refactor to migrate most elements to skeleton [skip app]
Browse files Browse the repository at this point in the history
  • Loading branch information
claustres committed Dec 17, 2024
1 parent 22a41e9 commit ff8b642
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 272 deletions.
29 changes: 3 additions & 26 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,18 @@ import { defineConfig } from 'vitepress'
export default defineConfig({
base: '/kApp',
title: 'kApp',
description: 'kApp - KDK application template',
description: 'kApp - KDK demonstration application',
ignoreDeadLinks: true,
head: [
['link', { rel: 'icon', href: 'https://s3.eu-central-1.amazonaws.com/kalisioscope/kapp/kapp-icon-color-2048x2048.png' }]
],
themeConfig: {
logo: 'https://s3.eu-central-1.amazonaws.com/kalisioscope/kapp/kapp-icon-color-2048x2048.png',
nav: [
{ text: 'About', link: '/about/introduction' },
{ text: 'Guides', link: '/guides/introduction' },
{ text: 'Reference', link: '/reference/configuration' }
{ text: 'About', link: '/about/introduction' }
],
sidebar: {
'/about/': getAboutSidebar(),
'/guides/': getGuidesSidebar(),
'/reference/': getReferenceSidebar()
'/about/': getAboutSidebar()
},
socialLinks: [
{ icon: 'github', link: 'https://github.com/kalisio/kApp' }
Expand All @@ -45,22 +41,3 @@ function getAboutSidebar () {
{ text: 'Contact', link: '/about/contact' }
]
}

function getGuidesSidebar () {
return [
{ text: 'Introduction', link: '/guides/introduction' },
{ text: 'Customizing kApp',
collapsed: true,
items: [
{ text: 'Tour', link: '/guides/customizing/tour' },
{ text: 'PWA', link: '/guides/customizing/pwa' }
]
}
]
}

function getReferenceSidebar () {
return [
{ text: 'Configuring a kApp', link: '/reference/configuration' }
]
}
13 changes: 8 additions & 5 deletions docs/about/introduction.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# About

**kApp** is an demonstration application based on the [Kalisio Development Kit](https://kalisio.github.io/kdk/) (**KDK**) available now as a single package [@kalisio/kdk](https://www.npmjs.com/package/@kalisio/kdk).

::: tip
For a deeper understanding of the overall structure, please refer to our [application template](https://kalisio.github.io/skeleton).
:::
The **kApp** (i.e. KDK-based Application) is a demonstration application created from the [skeleton](https://kalisio.github.io/skeleton/), which includes all the necessary boilerplate that you need to get started building your application with the [Kalisio Development Kit](https://kalisio.github.io/kdk/).

It also includes the minimum viable set of features to start:
* a [basic application layout](https://kalisio.github.io/kdk/api/core/components.html) including side navigation, application bar, right panel and various widgets
* ready-to-go [user authentication services](https://kalisio.github.io/kdk/api/core/services.html#users-service) and [screens](https://kalisio.github.io/kdk/api/core/components.html#authentication),
* a [basic service](https://kalisio.github.io/kdk/api/core/application.html) to create/remove documents in database,
* a [basic collection activity](https://kalisio.github.io/kdk/api/core/mixins.html) listing documents using either [a list, a grid or a table](https://kalisio.github.io/kdk/api/core/components.html#collections),
* a [basic editor](https://kalisio.github.io/kdk/api/core/components.html#editors) to fill document properties when creating a new document.

![kApp built with the KDK](../.vitepress/public/images/kApp.png)

Expand Down
28 changes: 0 additions & 28 deletions docs/guides/customizing/pwa.md

This file was deleted.

85 changes: 0 additions & 85 deletions docs/guides/customizing/tour.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/guides/introduction.md

This file was deleted.

111 changes: 0 additions & 111 deletions docs/reference/configuration.md

This file was deleted.

0 comments on commit ff8b642

Please sign in to comment.