diff --git a/docs/src/assets/Clippy.webp b/docs/src/assets/Clippy.webp new file mode 100644 index 0000000..e413d87 Binary files /dev/null and b/docs/src/assets/Clippy.webp differ diff --git a/docs/src/assets/houston.webp b/docs/src/assets/houston.webp deleted file mode 100644 index 930c164..0000000 Binary files a/docs/src/assets/houston.webp and /dev/null differ diff --git a/docs/src/content/docs/guides/example.md b/docs/src/content/docs/guides/example.md index ebd0f3b..90b6147 100644 --- a/docs/src/content/docs/guides/example.md +++ b/docs/src/content/docs/guides/example.md @@ -1,11 +1,7 @@ --- -title: Example Guide -description: A guide in my new Starlight docs site. +title: Installation guide +description: A guide in my new Clippy docs site. --- 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. - -## Further reading - -- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx index 664b681..06eebf7 100644 --- a/docs/src/content/docs/index.mdx +++ b/docs/src/content/docs/index.mdx @@ -1,36 +1,30 @@ --- -title: Welcome to Starlight +title: Welcome to Clippy description: Get started building your docs site with Starlight. template: splash hero: - tagline: Congrats on setting up a new Starlight project! + tagline: Well done! Your Clippy project is up and running! image: - file: ../../assets/houston.webp + file: ../../assets/Clippy.webp actions: - - text: Example Guide + - text: Installation guide link: /guides/example/ - icon: right-arrow - - text: Read the Starlight docs - link: https://starlight.astro.build - icon: external - variant: minimal + icon: left-arrow + --- -import { Card, CardGrid } from '@astrojs/starlight/components'; +import { Card, CardGrid } from "@astrojs/starlight/components"; ## Next steps - - 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`. - - - Learn more in [the Starlight Docs](https://starlight.astro.build/). - + + 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`. + diff --git a/docs/src/content/docs/reference/example.md b/docs/src/content/docs/reference/example.md deleted file mode 100644 index 0224f09..0000000 --- a/docs/src/content/docs/reference/example.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Example Reference -description: A reference page in my new Starlight docs site. ---- - -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. - -## Further reading - -- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework