Skip to content

Commit 9e1413b

Browse files
committed
docs(@datadive/docs): improve dosumentation landing page, about page and sidebar
1 parent 4fb2f8d commit 9e1413b

File tree

3 files changed

+48
-16
lines changed

3 files changed

+48
-16
lines changed

apps/docs/astro.config.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,24 @@ export default defineConfig({
3939
collapsed: false,
4040
},
4141
},
42+
{
43+
label: 'Datadive API',
44+
collapsed: true,
45+
items: [
46+
{
47+
label: 'Specification',
48+
link: '/spec',
49+
},
50+
{
51+
label: 'OpenAPI (JSON)',
52+
link: '/openapi.json',
53+
},
54+
{
55+
label: 'OpenAPI (YAML)',
56+
link: '/openapi.yml',
57+
},
58+
],
59+
},
4260
],
4361
}),
4462
],
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
---
22
title: About the Docs
33
---
4+
5+
This documentation was written as part of Luca Schultz's bachelor thesis *"Implementing Datadive: A Web Application for Data Analysis"* at the Behavioral Security Research Group at the University of Bonn in November 2024.
6+
7+
The thesis is available as a [PDF](/thesis.pdf) and can be read online [here](/thesis/introduction).
8+
9+
The source code for the Datadive platform is available on [GitHub](https://github.com/lucaschultz/datadive).

apps/docs/src/content/docs/index.mdx

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,35 @@ template: splash
55
hero:
66
tagline: Here you will find all the information you need to contribute to Datadive.
77
actions:
8-
- text: Project Setup
9-
link: /guides/example/
8+
- text: Learn More
9+
link: /about
1010
icon: right-arrow
1111
variant: primary
1212
---
1313

14-
import { Card, CardGrid } from '@astrojs/starlight/components'
14+
import { LinkCard, CardGrid, Card } from '@astrojs/starlight/components'
1515

1616
## Next steps
1717

18-
<CardGrid>
19-
<Card title='Add new content' icon='add-document'>
20-
Add Markdown or MDX files to `src/content/docs` to create new pages.
21-
</Card>
22-
<Card title='Update content' icon='add-document'>
23-
Edit `src/content/docs/index.mdx` to
24-
</Card>
25-
<Card title='Configure your site' icon='setting'>
26-
Edit your `sidebar` and other config in `astro.config.mjs`.
27-
</Card>
28-
<Card title='Read the docs' icon='open-book'>
29-
Learn more in [the Starlight Docs](https://starlight.astro.build/).
30-
</Card>
18+
<CardGrid stagger>
19+
<LinkCard
20+
href="thesis/introduction"
21+
title='Read the thesis online'
22+
description="Learn more about the Datadive platform in the Luca's bachelors thesis."
23+
/>
24+
<LinkCard
25+
href="/thesis.pdf"
26+
title='Download the thesis'
27+
description="Download Luca's bachelor thesis as a PDF file to read it offline."
28+
/>
29+
<LinkCard
30+
href="https://github.com/lucaschultz/datadive"
31+
title='Check out the GitHub repository'
32+
description='Contribute to the Datadive platform by checking out the source code on GitHub.'
33+
/>
34+
<LinkCard
35+
href="/spec"
36+
title='Check out the API specification'
37+
description='Learn more about the Datadive HTTP API by checking out the OpenAPI specification.'
38+
/>
3139
</CardGrid>

0 commit comments

Comments
 (0)