Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
EinMelih authored and 0-don committed Jan 2, 2025
1 parent 42c34e6 commit 331b47b
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 39 deletions.
Binary file added docs/src/assets/Clippy.webp
Binary file not shown.
Binary file removed docs/src/assets/houston.webp
Binary file not shown.
8 changes: 2 additions & 6 deletions docs/src/content/docs/guides/example.md
Original file line number Diff line number Diff line change
@@ -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
38 changes: 16 additions & 22 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -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

<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>
<Card title="Read the docs" icon="open-book">
Learn more in [the Starlight Docs](https://starlight.astro.build/).
</Card>
<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>
</CardGrid>
11 changes: 0 additions & 11 deletions docs/src/content/docs/reference/example.md

This file was deleted.

0 comments on commit 331b47b

Please sign in to comment.