From c2bdd9716057d9997343c546b177222559d42ef8 Mon Sep 17 00:00:00 2001 From: Jacob Jenkins Date: Thu, 1 Feb 2024 16:45:12 +0000 Subject: [PATCH 1/9] add basic page --- docs/astro.config.ts | 9 +++++++++ docs/src/content/docs/why-aik/index.mdx | 6 ++++++ 2 files changed, 15 insertions(+) create mode 100644 docs/src/content/docs/why-aik/index.mdx diff --git a/docs/astro.config.ts b/docs/astro.config.ts index 9d5e7579..e1b07517 100644 --- a/docs/astro.config.ts +++ b/docs/astro.config.ts @@ -18,6 +18,15 @@ export default defineConfig({ "https://github.com/florian-lefebvre/astro-integration-kit/edit/main/docs/", }, sidebar: [ + { + label: "Introduction", + items: [ + { + label: "Why Astro Integration Kit", + link: "/why-aik", + }, + ], + }, { label: "Getting started", items: [ diff --git a/docs/src/content/docs/why-aik/index.mdx b/docs/src/content/docs/why-aik/index.mdx new file mode 100644 index 00000000..29cef0ad --- /dev/null +++ b/docs/src/content/docs/why-aik/index.mdx @@ -0,0 +1,6 @@ +--- +title: Why use Astro Integration Kit +description: Learn why you should use Astro Integration Kit to build your next Astro Integration. +--- + +Hi \ No newline at end of file From b32d31995ddedcb8a53a2dd7145a10bf7c14848b Mon Sep 17 00:00:00 2001 From: Jacob Jenkins Date: Thu, 1 Feb 2024 21:02:01 +0000 Subject: [PATCH 2/9] wip --- docs/src/content/docs/why-aik/index.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/src/content/docs/why-aik/index.mdx b/docs/src/content/docs/why-aik/index.mdx index 29cef0ad..be0857dc 100644 --- a/docs/src/content/docs/why-aik/index.mdx +++ b/docs/src/content/docs/why-aik/index.mdx @@ -3,4 +3,10 @@ title: Why use Astro Integration Kit description: Learn why you should use Astro Integration Kit to build your next Astro Integration. --- -Hi \ No newline at end of file +Astro Integration Kit is a community-driven effort to improve the power, flexibility and, most importantly, developer experience of creating Astro Integrations. + +We are creating AIK because we want to create a robust, battle-tested suite of tools to make creating Astro integrations easier. In the hopes that one day this will become part of the core Astro framework. + +We are constantly gathering feedback from the entire community, from first-time integration builders to the seasoned Astro Core team themselves. + +Astro Integration Kit is currently an experimental technology that's still subject to changes as we solidify the APIs. However they have been built from techniques in use in production-level integrations across the Astro Ecosystem. \ No newline at end of file From a3ecb20b4149c520ce1845537be94feddf9120ce Mon Sep 17 00:00:00 2001 From: Jacob Jenkins Date: Thu, 1 Feb 2024 21:57:44 +0000 Subject: [PATCH 3/9] adds more details --- docs/src/content/docs/why-aik/index.mdx | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/src/content/docs/why-aik/index.mdx b/docs/src/content/docs/why-aik/index.mdx index be0857dc..b865e64b 100644 --- a/docs/src/content/docs/why-aik/index.mdx +++ b/docs/src/content/docs/why-aik/index.mdx @@ -5,8 +5,14 @@ description: Learn why you should use Astro Integration Kit to build your next A Astro Integration Kit is a community-driven effort to improve the power, flexibility and, most importantly, developer experience of creating Astro Integrations. -We are creating AIK because we want to create a robust, battle-tested suite of tools to make creating Astro integrations easier. In the hopes that one day this will become part of the core Astro framework. +We are creating Astro Integration Kit because we want to create a robust, battle-tested suite of tools to make creating Astro integrations easier. In the hopes that one day this will become part of the core Astro framework. We are constantly gathering feedback from the entire community, from first-time integration builders to the seasoned Astro Core team themselves. -Astro Integration Kit is currently an experimental technology that's still subject to changes as we solidify the APIs. However they have been built from techniques in use in production-level integrations across the Astro Ecosystem. \ No newline at end of file +Astro Integration Kit is currently an experimental technology that's still subject to changes as we solidify the APIs. However they have been built from techniques in use in production-level integrations across the Astro Ecosystem. + +Typically Integrations require quite low-level knowledge of Astro and Vite to make successfully. So Astro Integration Kit abstracts a lot of low-level implementation into easy-to-use utilities. Things such as Vite Virtual Modules or creating Typescript Declaration files for your users. + +Small utilities allow you to adhere to best practices with the minumum amount of code. + +Once we've got a standard way of creating Astro Integrations we can create content and guides much more easily using well documented utilities meaning more people will be able to create more advanced integrations. From c9c0fe33cf75b2a316b6c9e2dcc496a3b77dc89c Mon Sep 17 00:00:00 2001 From: Jacob Jenkins Date: Thu, 1 Feb 2024 22:00:53 +0000 Subject: [PATCH 4/9] renames path --- docs/astro.config.ts | 9 ++------- .../docs/{why-aik/index.mdx => getting-started/why.mdx} | 0 2 files changed, 2 insertions(+), 7 deletions(-) rename docs/src/content/docs/{why-aik/index.mdx => getting-started/why.mdx} (100%) diff --git a/docs/astro.config.ts b/docs/astro.config.ts index e1b07517..d65af4a8 100644 --- a/docs/astro.config.ts +++ b/docs/astro.config.ts @@ -19,17 +19,12 @@ export default defineConfig({ }, sidebar: [ { - label: "Introduction", + label: "Getting started", items: [ { label: "Why Astro Integration Kit", - link: "/why-aik", + link: "/getting-started/why", }, - ], - }, - { - label: "Getting started", - items: [ { label: "Installation", link: "/getting-started/installation/", diff --git a/docs/src/content/docs/why-aik/index.mdx b/docs/src/content/docs/getting-started/why.mdx similarity index 100% rename from docs/src/content/docs/why-aik/index.mdx rename to docs/src/content/docs/getting-started/why.mdx From 407945b6b6fa3ed36c1f5a9b48cd12f880eefa42 Mon Sep 17 00:00:00 2001 From: Jacob Jenkins Date: Fri, 2 Feb 2024 10:15:19 +0000 Subject: [PATCH 5/9] Update with Grammarly suggestions Co-authored-by: Luiz Ferraz --- docs/src/content/docs/getting-started/why.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/src/content/docs/getting-started/why.mdx b/docs/src/content/docs/getting-started/why.mdx index b865e64b..d1022d15 100644 --- a/docs/src/content/docs/getting-started/why.mdx +++ b/docs/src/content/docs/getting-started/why.mdx @@ -3,16 +3,16 @@ title: Why use Astro Integration Kit description: Learn why you should use Astro Integration Kit to build your next Astro Integration. --- -Astro Integration Kit is a community-driven effort to improve the power, flexibility and, most importantly, developer experience of creating Astro Integrations. +Astro Integration Kit is a community-driven effort to improve the power, flexibility, and, most importantly, developer experience of creating Astro Integrations. -We are creating Astro Integration Kit because we want to create a robust, battle-tested suite of tools to make creating Astro integrations easier. In the hopes that one day this will become part of the core Astro framework. +We are creating the Astro Integration Kit because we want to create a robust, battle-tested suite of tools to make creating Astro integrations easier in the hopes that one day, this will become part of the core Astro framework. -We are constantly gathering feedback from the entire community, from first-time integration builders to the seasoned Astro Core team themselves. +We constantly gather feedback from the entire community, from first-time integration builders to the seasoned Astro Core team. -Astro Integration Kit is currently an experimental technology that's still subject to changes as we solidify the APIs. However they have been built from techniques in use in production-level integrations across the Astro Ecosystem. +Astro Integration Kit is currently an experimental technology that's still subject to changes as we solidify the APIs. However, it was built from techniques used in production-level integrations across the Astro Ecosystem. -Typically Integrations require quite low-level knowledge of Astro and Vite to make successfully. So Astro Integration Kit abstracts a lot of low-level implementation into easy-to-use utilities. Things such as Vite Virtual Modules or creating Typescript Declaration files for your users. +Integrations typically require quite a low-level knowledge of Astro and Vite to be made successfully. So, Astro Integration Kit abstracts a lot of low-level implementation into easy-to-use utilities. Things such as Vite Virtual Modules or creating Typescript Declaration files for your users. -Small utilities allow you to adhere to best practices with the minumum amount of code. +Small utilities allow you to adhere to best practices with the minimum amount of code. -Once we've got a standard way of creating Astro Integrations we can create content and guides much more easily using well documented utilities meaning more people will be able to create more advanced integrations. +Once we have a standard way of creating Astro Integrations, we can create content and guides much more easily using well-documented utilities, enabling more people to create more advanced integrations. From 173911bddcb65a29bbd54982efafdc8d80b467ff Mon Sep 17 00:00:00 2001 From: Jacob Jenkins Date: Fri, 2 Feb 2024 10:38:47 +0000 Subject: [PATCH 6/9] move link and add note to why --- docs/astro.config.ts | 8 ++++---- docs/src/content/docs/getting-started/why.mdx | 6 ++++++ 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/astro.config.ts b/docs/astro.config.ts index d65af4a8..ec1dd1c5 100644 --- a/docs/astro.config.ts +++ b/docs/astro.config.ts @@ -21,10 +21,6 @@ export default defineConfig({ { label: "Getting started", items: [ - { - label: "Why Astro Integration Kit", - link: "/getting-started/why", - }, { label: "Installation", link: "/getting-started/installation/", @@ -33,6 +29,10 @@ export default defineConfig({ label: "Usage", link: "/getting-started/usage/", }, + { + label: "Why Astro Integration Kit", + link: "/getting-started/why", + }, { label: "Showcase", link: "/getting-started/showcase/", diff --git a/docs/src/content/docs/getting-started/why.mdx b/docs/src/content/docs/getting-started/why.mdx index d1022d15..70d8d77c 100644 --- a/docs/src/content/docs/getting-started/why.mdx +++ b/docs/src/content/docs/getting-started/why.mdx @@ -16,3 +16,9 @@ Integrations typically require quite a low-level knowledge of Astro and Vite to Small utilities allow you to adhere to best practices with the minimum amount of code. Once we have a standard way of creating Astro Integrations, we can create content and guides much more easily using well-documented utilities, enabling more people to create more advanced integrations. + +:::note +We are constantly looking for feedback and contributions from the community. Whether it's contributing code, ideas or suggestions; feel free to post an issue on the Github Repo: https://github.com/florian-lefebvre/astro-integration-ki + +Or get involved with the discussion on the official Astro Integrations Discord channel: https://discord.com/channels/830184174198718474/1197638002764152843 +::: \ No newline at end of file From 00ece835a02228d30816d52eedb461ddc3d5e963 Mon Sep 17 00:00:00 2001 From: Jacob Jenkins Date: Fri, 2 Feb 2024 10:39:55 +0000 Subject: [PATCH 7/9] t --- docs/src/content/docs/getting-started/why.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/content/docs/getting-started/why.mdx b/docs/src/content/docs/getting-started/why.mdx index 70d8d77c..060f410a 100644 --- a/docs/src/content/docs/getting-started/why.mdx +++ b/docs/src/content/docs/getting-started/why.mdx @@ -18,7 +18,7 @@ Small utilities allow you to adhere to best practices with the minimum amount of Once we have a standard way of creating Astro Integrations, we can create content and guides much more easily using well-documented utilities, enabling more people to create more advanced integrations. :::note -We are constantly looking for feedback and contributions from the community. Whether it's contributing code, ideas or suggestions; feel free to post an issue on the Github Repo: https://github.com/florian-lefebvre/astro-integration-ki +We are constantly looking for feedback and contributions from the community. Whether it's contributing code, ideas or suggestions; feel free to post an issue on the Github Repo: https://github.com/florian-lefebvre/astro-integration-kit Or get involved with the discussion on the official Astro Integrations Discord channel: https://discord.com/channels/830184174198718474/1197638002764152843 ::: \ No newline at end of file From f2ca2ddd88b4966dede50fcd322ee298f2e9f99f Mon Sep 17 00:00:00 2001 From: Jacob Jenkins Date: Fri, 2 Feb 2024 10:55:43 +0000 Subject: [PATCH 8/9] Update docs/src/content/docs/getting-started/why.mdx Co-authored-by: Florian Lefebvre --- docs/src/content/docs/getting-started/why.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/content/docs/getting-started/why.mdx b/docs/src/content/docs/getting-started/why.mdx index 060f410a..36f5ec24 100644 --- a/docs/src/content/docs/getting-started/why.mdx +++ b/docs/src/content/docs/getting-started/why.mdx @@ -18,7 +18,7 @@ Small utilities allow you to adhere to best practices with the minimum amount of Once we have a standard way of creating Astro Integrations, we can create content and guides much more easily using well-documented utilities, enabling more people to create more advanced integrations. :::note -We are constantly looking for feedback and contributions from the community. Whether it's contributing code, ideas or suggestions; feel free to post an issue on the Github Repo: https://github.com/florian-lefebvre/astro-integration-kit +We are constantly looking for feedback and contributions from the community. Whether it's contributing code, ideas or suggestions; feel free to create an issue on [our GitHub repository](https://github.com/florian-lefebvre/astro-integration-kit). Or get involved with the discussion on the official Astro Integrations Discord channel: https://discord.com/channels/830184174198718474/1197638002764152843 ::: \ No newline at end of file From 2aa494c6db0760c3354b01423e7f4ad4f463f217 Mon Sep 17 00:00:00 2001 From: Jacob Jenkins Date: Fri, 2 Feb 2024 10:55:53 +0000 Subject: [PATCH 9/9] Update docs/src/content/docs/getting-started/why.mdx Co-authored-by: Florian Lefebvre --- docs/src/content/docs/getting-started/why.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/content/docs/getting-started/why.mdx b/docs/src/content/docs/getting-started/why.mdx index 36f5ec24..b7e838c0 100644 --- a/docs/src/content/docs/getting-started/why.mdx +++ b/docs/src/content/docs/getting-started/why.mdx @@ -20,5 +20,5 @@ Once we have a standard way of creating Astro Integrations, we can create conten :::note We are constantly looking for feedback and contributions from the community. Whether it's contributing code, ideas or suggestions; feel free to create an issue on [our GitHub repository](https://github.com/florian-lefebvre/astro-integration-kit). -Or get involved with the discussion on the official Astro Integrations Discord channel: https://discord.com/channels/830184174198718474/1197638002764152843 +Or get involved with the discussion on the [`#dev-integrations `channel](https://discord.com/channels/830184174198718474/1197638002764152843) of the official [Astro Discord server](https://astro.build/chat)! ::: \ No newline at end of file