Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: migrate to new docs #1460

Merged
merged 28 commits into from
Oct 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
736090b
docs: base level nuxt-3 app
mattmaribojoc Jul 14, 2023
47d45c3
docs: try adding an image
mattmaribojoc Jul 14, 2023
e4ebad2
docs: temporary hide links
mattmaribojoc Jul 17, 2023
f8dc23e
docs: update index.md
mattmaribojoc Jul 20, 2023
194e180
docs: update boilerplate
mattmaribojoc Aug 6, 2023
a580eb7
docs: fix links
mattmaribojoc Aug 8, 2023
d3427a7
docs: fix broken links
mattmaribojoc Aug 8, 2023
b056465
docs: fix reference links
mattmaribojoc Aug 17, 2023
e70b132
chore: remove docs-deployment
mattmaribojoc Aug 28, 2023
18fa2e4
fix enterprise link
sethidden Sep 12, 2023
e09ca1a
fix link id
sethidden Sep 12, 2023
0a1323d
fix link to extensions guide
sethidden Sep 12, 2023
dbc06ef
IN-3614 Remove key concepts
sethidden Sep 12, 2023
b5aaa3f
Fix order of pages in getting started section
sethidden Sep 13, 2023
d90d436
Misc -> Miscellaneous
sethidden Sep 13, 2023
85d2f6d
Use symlinks instead of copying CHANGELOG.md
sethidden Sep 14, 2023
77a9208
Add API reference
sethidden Sep 14, 2023
3cc7f08
Rebuild api reference during yarn changeset version
sethidden Sep 14, 2023
1c42172
Ensure most important Basics section pages are at top
sethidden Sep 14, 2023
7509ce7
disable navigation and update changelog format
sethidden Sep 14, 2023
f8ccc1b
add dummy .md files
sethidden Sep 15, 2023
288d39f
update version script
sethidden Sep 15, 2023
05dc324
remove duplicated api reference
sethidden Sep 19, 2023
4fa4715
import config helper
sethidden Sep 20, 2023
1d15f7f
fix order in basics section
sethidden Sep 20, 2023
f8adc12
change first section order
sethidden Sep 20, 2023
01578ee
add changelog update scripts
sethidden Sep 26, 2023
dd17613
add api reference and changelogs
sethidden Sep 26, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading