Skip to content

Commit 9d65056

Browse files
committed
Update content, add links, image. Remove title.
1 parent bbcb9c7 commit 9d65056

File tree

5 files changed

+16
-21
lines changed

5 files changed

+16
-21
lines changed

astro.config.mjs

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import starlight from '@astrojs/starlight';
55
export default defineConfig({
66
site: 'https://recogito.github.io/',
77
integrations: [starlight({
8-
title: 'Developer Documentation',
8+
title: '',
99
defaultLocale: 'root',
1010
// optional
1111
locales: {

src/assets/stupendous-nature.png

289 KB
Loading

src/content/docs/guides/example.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
title: Example Guide
3-
description: A guide in my new Starlight docs site.
2+
title: Self Hosting
3+
description: This is where self hosting documentation will live eventually
44
---
55

6-
Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
7-
Writing a good guide requires thinking about what your users are trying to do.
6+
This will be a step by step guide to self hosting Recogito Studio. It will include information on how to install and configure the software, as well as how to maintain and update it (eventually).
87

98
## Further reading
109

11-
- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
10+
- There is currently a README [here](https://github.com/recogito/recogito-studio/blob/main/README.md).

src/content/docs/index.mdx

+7-10
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,20 @@ template: splash
55
hero:
66
tagline: An Extensible Platform for Collaborative, Standards-Based Annotation of TEI Text, IIIF Images, and PDFs. Modern, Open Source, and Easy to Use.
77
image:
8-
file: ../../assets/recogito-text.png
8+
file: ../../assets/stupendous-nature.png
99
---
1010

1111
import { Card, CardGrid } from '@astrojs/starlight/components';
1212

1313

1414
<CardGrid stagger>
15-
<Card title="Update content" icon="pencil">
16-
Edit `src/content/docs/index.mdx` to see this page change.
17-
</Card>
18-
<Card title="Add new content" icon="add-document">
19-
Add Markdown or MDX files to `src/content/docs` to create new pages.
20-
</Card>
21-
<Card title="Configure your site" icon="setting">
22-
Edit your `sidebar` and other config in `astro.config.mjs`.
15+
<Card title="Check it Out" icon="approve-check">
16+
[Contact us](https://www.performantsoftware.com/pages/recogito/) to schedule a demo.
2317
</Card>
2418
<Card title="Read the docs" icon="open-book">
25-
Learn more in [the Starlight Docs](https://starlight.astro.build/).
19+
[Access Documentation](https://github.com/recogito/recogito-studio) for self-hosting.
20+
</Card>
21+
<Card title="Get Help" icon="comment-alt">
22+
Join a community of users in the [Recogito Forum](https://community.performantsoftware.com/).
2623
</Card>
2724
</CardGrid>

src/content/docs/reference/example.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
title: Example Reference
3-
description: A reference page in my new Starlight docs site.
2+
title: Extension Reference
3+
description: This page will cover how Recogito Studio extensions work.
44
---
55

6-
Reference pages are ideal for outlining how things work in terse and clear terms.
7-
Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
6+
For now, there is just one extension: a geotagging feature that allows users to link annotations to gazetteer entries. This feature is currently in development and will be available soon.
87

98
## Further reading
109

11-
- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework
10+
- More soon!

0 commit comments

Comments
 (0)