Skip to content

Commit

Permalink
docs(sdk): update sdk docs
Browse files Browse the repository at this point in the history
  • Loading branch information
LeoMunizOdoo committed Oct 24, 2023
1 parent 1183ef9 commit a001b47
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 13 deletions.
11 changes: 6 additions & 5 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module.exports = {
title: 'Odoo Integration',
title: 'Vue Storefront 2 for Odoo Integration',
base: '/odoo/',
description: 'This project is a Odoo integration documentation',
head: [['link', { rel: 'icon', href: '/favicon.png' }]],
Expand Down Expand Up @@ -33,16 +33,17 @@ module.exports = {
title: 'Essentials',
collapsable: false,
children: [
['/', 'Introduction'],

'/essentials/maintainers'
['/', 'Introduction']
]
},
{
title: 'VSF SDK',
collapsable: false,
children: [
['/overview/', 'Overview'],
['/sdk/architecture', 'Architecture'],
['/sdk/bootstrap', 'Getting started'],
['/sdk/middleware', 'Middleware'],
['/sdk/methods', 'Methods'],
]
},
{
Expand Down
Binary file added docs/.vuepress/public/assets/archtecture.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/assets/archtecture_.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 0 additions & 8 deletions docs/overview/index.md

This file was deleted.

10 changes: 10 additions & 0 deletions docs/sdk/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Architecture

Based on default VSF archtecture with some extensions.
<br/>
https://docs.vuestorefront.io/general/basics/architecture


<br/>

<img :src="$withBase('/assets/archtecture.png')" alt="create_new_project" />
1 change: 1 addition & 0 deletions docs/sdk/bootstrap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Getting started
2 changes: 2 additions & 0 deletions docs/sdk/methods.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Sdk

3 changes: 3 additions & 0 deletions docs/sdk/middleware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Middleware


0 comments on commit a001b47

Please sign in to comment.