Skip to content

Commit

Permalink
docs: migrate to new docs (#1460)
Browse files Browse the repository at this point in the history
* docs: base level nuxt-3 app

* docs: try adding an image

* docs: temporary hide links

* docs: update index.md

* docs: update boilerplate

* docs: fix links

* docs: fix broken links

* docs: fix reference links

* chore: remove docs-deployment

* fix enterprise link

* fix link id

* fix link to extensions guide

* IN-3614 Remove key concepts

* Fix order of pages in getting started section

Rename Scope to Supported Features

* Misc -> Miscellaneous

* Use symlinks instead of copying CHANGELOG.md

This will only work on UNIX

* Add API reference

* Rebuild api reference during yarn changeset version

* Ensure most important Basics section pages are at top

* disable navigation and update changelog format

* add dummy .md files

* update version script

* remove duplicated api reference

* import config helper

* fix order in basics section

* change first section order

* add changelog update scripts

* add api reference and changelogs

---------

Co-authored-by: Artur Tagisow <[email protected]>
  • Loading branch information
mattmaribojoc and sethidden committed Oct 11, 2023
1 parent b000722 commit 149d4b3
Show file tree
Hide file tree
Showing 61 changed files with 212,621 additions and 10,428 deletions.
84 changes: 0 additions & 84 deletions .github/workflows/docs-deployment.yaml

This file was deleted.

3 changes: 0 additions & 3 deletions docs/.gitignore

This file was deleted.

116 changes: 0 additions & 116 deletions docs/.vuepress/config.js

This file was deleted.

6 changes: 0 additions & 6 deletions docs/.vuepress/enhanceApp.js

This file was deleted.

10 changes: 0 additions & 10 deletions docs/.vuepress/plugins/additionalPages.js

This file was deleted.

Binary file removed docs/.vuepress/public/favicon.png
Binary file not shown.
Binary file removed docs/.vuepress/public/hero.png
Binary file not shown.
Binary file removed docs/.vuepress/public/sdk-magento2/hero.png
Binary file not shown.
21 changes: 0 additions & 21 deletions docs/.vuepress/styles/index.styl

This file was deleted.

1 change: 0 additions & 1 deletion docs/.vuepress/styles/palette.styl

This file was deleted.

22 changes: 22 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Vue Storefront Docs Starter

Welcome to the Vue Storefront Docs Boilerplate! If you're creating a new Vue Storefront 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 Vue Storefront 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 Vue Storefront 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 Vue Storefront 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 VSF 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.

30 changes: 0 additions & 30 deletions docs/basics/cart.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs/basics/checkout.md

This file was deleted.

21 changes: 0 additions & 21 deletions docs/basics/products.md

This file was deleted.

Loading

0 comments on commit 149d4b3

Please sign in to comment.