From 6cfcf51752ec8d40104cead0b2602885c77a9c79 Mon Sep 17 00:00:00 2001 From: Jay V Date: Wed, 21 May 2025 14:24:53 -0400 Subject: adding docs site --- www/src/content/docs/guides/example.md | 11 +++++++++++ www/src/content/docs/index.mdx | 12 ++++++++++++ www/src/content/docs/reference/example.md | 11 +++++++++++ 3 files changed, 34 insertions(+) create mode 100644 www/src/content/docs/guides/example.md create mode 100644 www/src/content/docs/index.mdx create mode 100644 www/src/content/docs/reference/example.md (limited to 'www/src/content/docs') diff --git a/www/src/content/docs/guides/example.md b/www/src/content/docs/guides/example.md new file mode 100644 index 000000000..ebd0f3bc7 --- /dev/null +++ b/www/src/content/docs/guides/example.md @@ -0,0 +1,11 @@ +--- +title: Example Guide +description: A guide in my new Starlight 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/www/src/content/docs/index.mdx b/www/src/content/docs/index.mdx new file mode 100644 index 000000000..176520ec5 --- /dev/null +++ b/www/src/content/docs/index.mdx @@ -0,0 +1,12 @@ +--- +title: OpenCode +description: The AI coding agent built for the terminal. +template: splash +hero: + title: The AI coding agent built for the terminal. + tagline: The AI coding agent built for the terminal. + image: + dark: ../../assets/logo-dark.svg + light: ../../assets/logo-light.svg + alt: OpenCode logo +--- diff --git a/www/src/content/docs/reference/example.md b/www/src/content/docs/reference/example.md new file mode 100644 index 000000000..0224f096c --- /dev/null +++ b/www/src/content/docs/reference/example.md @@ -0,0 +1,11 @@ +--- +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 -- cgit v1.2.3