From 94c04151c6de4613f11d8dbafd7f6457add46fd9 Mon Sep 17 00:00:00 2001 From: Wojciech Sikora <35867383+WojtekTheWebDev@users.noreply.github.com> Date: Tue, 19 Mar 2024 10:29:39 +0100 Subject: [PATCH] Delete docs/README.md --- docs/README.md | 22 ---------------------- 1 file changed, 22 deletions(-) delete mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index bba055223..000000000 --- a/docs/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# Alokai Docs Starter - -Welcome to the Alokai Docs Boilerplate! If you're creating a new Alokai integration, this is the place to start. - -This Nuxt project can help you preview your content locally and get it ready to be merged into the Alokai docs. - -It extends our [Base Layer](https://docs.vuestorefront.io/community/contributing/docs/base-layer) to give you all of the modules, components, and features available in the deployed Alokai docs. - -Then, when you're ready to publish your content, we'll work with you to get add the `content` folder of this project as a remote Git source for the Alokai docs. - -## Tips - -You can use the rest of this project to preview your content locally, but any components/layouts/composables/etc. will not be available to the published docs. - -If you need additional functionality, reach out to us on [Discord](https://discord.vuestorefront.io) and we'll work with you to get it added to the docs base layer and make it available to all of our docs projects. - -But remember - if you're publishing through the Alokai docs, only your `content` folder will be pulled into the docs. - -### Place images directly in the `content` folder - -If you need to use images in your content, you can place them directly in the `content` folder. Then, you can reference them in your content using the relative path. -