diff --git a/astro.config.mjs b/astro.config.mjs index 33968fe..2841dbc 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -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: { diff --git a/src/assets/stupendous-nature.png b/src/assets/stupendous-nature.png new file mode 100644 index 0000000..117cde1 Binary files /dev/null and b/src/assets/stupendous-nature.png differ diff --git a/src/content/docs/guides/example.md b/src/content/docs/guides/example.md index ebd0f3b..891a402 100644 --- a/src/content/docs/guides/example.md +++ b/src/content/docs/guides/example.md @@ -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). diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 8ea4dba..bec162b 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -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'; - - Edit `src/content/docs/index.mdx` to see this page change. - - - Add Markdown or MDX files to `src/content/docs` to create new pages. - - - Edit your `sidebar` and other config in `astro.config.mjs`. + + [Contact us](https://www.performantsoftware.com/pages/recogito/) to schedule a demo. - Learn more in [the Starlight Docs](https://starlight.astro.build/). + [Access Documentation](https://github.com/recogito/recogito-studio) for self-hosting. + + + Join a community of users in the [Recogito Forum](https://community.performantsoftware.com/). diff --git a/src/content/docs/reference/example.md b/src/content/docs/reference/example.md index 0224f09..94b2b78 100644 --- a/src/content/docs/reference/example.md +++ b/src/content/docs/reference/example.md @@ -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!