Skip to content

Commit

Permalink
Update content, add links, image. Remove title.
Browse files Browse the repository at this point in the history
  • Loading branch information
jamiefolsom committed Jun 27, 2024
1 parent bbcb9c7 commit 9d65056
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 21 deletions.
2 changes: 1 addition & 1 deletion astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import starlight from '@astrojs/starlight';
export default defineConfig({
site: 'https://recogito.github.io/',
integrations: [starlight({
title: 'Developer Documentation',
title: '',
defaultLocale: 'root',
// optional
locales: {
Expand Down
Binary file added src/assets/stupendous-nature.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 4 additions & 5 deletions src/content/docs/guides/example.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: Example Guide
description: A guide in my new Starlight docs site.
title: Self Hosting
description: This is where self hosting documentation will live eventually
---

Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
Writing a good guide requires thinking about what your users are trying to do.
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).

## Further reading

- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
- There is currently a README [here](https://github.com/recogito/recogito-studio/blob/main/README.md).
17 changes: 7 additions & 10 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,20 @@ template: splash
hero:
tagline: An Extensible Platform for Collaborative, Standards-Based Annotation of TEI Text, IIIF Images, and PDFs. Modern, Open Source, and Easy to Use.
image:
file: ../../assets/recogito-text.png
file: ../../assets/stupendous-nature.png
---

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


<CardGrid stagger>
<Card title="Update content" icon="pencil">
Edit `src/content/docs/index.mdx` to see this page change.
</Card>
<Card title="Add new content" icon="add-document">
Add Markdown or MDX files to `src/content/docs` to create new pages.
</Card>
<Card title="Configure your site" icon="setting">
Edit your `sidebar` and other config in `astro.config.mjs`.
<Card title="Check it Out" icon="approve-check">
[Contact us](https://www.performantsoftware.com/pages/recogito/) to schedule a demo.
</Card>
<Card title="Read the docs" icon="open-book">
Learn more in [the Starlight Docs](https://starlight.astro.build/).
[Access Documentation](https://github.com/recogito/recogito-studio) for self-hosting.
</Card>
<Card title="Get Help" icon="comment-alt">
Join a community of users in the [Recogito Forum](https://community.performantsoftware.com/).
</Card>
</CardGrid>
9 changes: 4 additions & 5 deletions src/content/docs/reference/example.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: Example Reference
description: A reference page in my new Starlight docs site.
title: Extension Reference
description: This page will cover how Recogito Studio extensions work.
---

Reference pages are ideal for outlining how things work in terse and clear terms.
Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
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.

## Further reading

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

0 comments on commit 9d65056

Please sign in to comment.