docs: publish restructure (#3496)

* docs: added features and guides overview page

* added image

* added version 2

* added version 3

* added version 4

* docs: implemented new color scheme

* docs: redesigned sidebar (#3193)

* docs: redesigned navbar for restructure (#3199)

* docs: redesigned footer (#3209)

* docs: redesigned cards (#3230)

* docs: redesigned admonitions (#3231)

* docs: redesign announcement bar (#3236)

* docs: redesigned large cards (#3239)

* docs: redesigned code blocks (#3253)

* docs: redesigned search modal and page (#3264)

* docs: redesigned doc footer (#3268)

* docs: added new sidebars + refactored css and assets (#3279)

* docs: redesigned api reference sidebar

* docs: refactored css

* docs: added code tabs transition

* docs: added new sidebars

* removed unused assets

* remove unusued assets

* Fix deploy errors

* fix incorrect link

* docs: fixed code responsivity + missing icons (#3283)

* docs: changed icons (#3296)

* docs: design fixes to the sidebar (#3297)

* redesign fixes

* docs: small design fixes

* docs: several design fixes after restructure (#3299)

* docs: bordered icon fixes

* docs: desgin fixes

* fixes to code blocks and sidebar scroll

* design adjustments

* docs: restructured homepage (#3305)

* docs: restructured homepage

* design fixes

* fixed core concepts icon

* docs: added core concepts page (#3318)

* docs: restructured homepage

* design fixes

* docs: added core concepts page

* changed text of different components

* docs: added architecture link

* added missing prop for user guide

* docs: added regions overview page (#3327)

* docs: added regions overview

* moved region pages to new structure

* docs: fixed description of regions architecture page

* small changes

* small fix

* docs: added customers overview page (#3331)

* docs: added regions overview

* moved region pages to new structure

* docs: fixed description of regions architecture page

* small changes

* small fix

* docs: added customers overview page

* fix link

* resolve link issues

* docs: updated regions architecture image

* docs: second-iteration fixes (#3347)

* docs: redesigned document

* design fixes

* docs: added products overview page (#3354)

* docs: added carts overview page (#3363)

* docs: added orders overview (#3364)

* docs: added orders overview

* added links in overview

* docs: added vercel redirects

* docs: added soon badge for cards (#3389)

* docs: resolved feedback changes + organized troubleshooting pages (#3409)

* docs: resolved feedback changes

* added extra line

* docs: changed icons for restructure (#3421)

* docs: added taxes overview page (#3422)

* docs: added taxes overview page

* docs: fix sidebar label

* added link to taxes overview page

* fixed link

* docs: fixed sidebar scroll (#3429)

* docs: added discounts overview (#3432)

* docs: added discounts overview

* fixed links

* docs: added gift cards overview (#3433)

* docs: added price lists overview page (#3440)

* docs: added price lists overview page

* fixed links

* docs: added sales channels overview page (#3441)

* docs: added sales overview page

* fixed links

* docs: added users overview (#3443)

* docs: fixed sidebar border height (#3444)

* docs: fixed sidebar border height

* fixed svg markup

* docs: added possible solutions to feedback component (#3449)

* docs: added several overview pages + restructured files (#3463)

* docs: added several overview pages

* fixed links

* docs: added feature flags + PAK overview pages (#3464)

* docs: added feature flags + PAK overview pages

* fixed links

* fix link

* fix link

* fixed links colors

* docs: added strategies overview page (#3468)

* docs: automated upgrade guide (#3470)

* docs: automated upgrade guide

* fixed vercel redirect

* docs: restructured files in docs codebase (#3475)

* docs: restructured files

* docs: fixed eslint exception

* docs: finished restructure loose-ends (#3493)

* fixed uses of backend

* docs: finished loose ends

* eslint fixes

* fixed links

* merged master

* added update instructions for v1.7.12
This commit is contained in:
Shahed Nasser
2023-03-16 17:03:10 +02:00
committed by GitHub
parent f312ce1e0f
commit 1decaa27c7
415 changed files with 12422 additions and 5098 deletions
+39 -99
View File
@@ -3,7 +3,7 @@ const path = require("path")
const fs = require("fs")
const docsPath = path.join(__dirname, "../../docs/content")
const apisPath = path.join(__dirname, "../../docs/api")
// const reverseSidebar = require('./src/utils/reverseSidebar')
const reverseSidebar = require('./src/utils/reverseSidebar')
const algoliaAppId = process.env.ALGOLIA_APP_ID || "temp"
const algoliaApiKey = process.env.ALGOLIA_API_KEY || "temp"
@@ -61,116 +61,48 @@ const config = {
srcDark: "img/logo-dark.png"
},
items: [
{
type: 'search',
position: 'left',
},
{
type: "docSidebar",
sidebarId: "docsSidebar",
label: "Docs"
sidebarId: "homepage",
label: "Docs",
position: "right"
},
{
type: "docSidebar",
sidebarId: "userGuideSidebar",
label: "User Guide"
label: "User Guide",
position: "right"
},
{
href: "/api/store",
label: "Store API",
prependBaseUrlToHref: true,
target: '_blank'
target: '_blank',
position: "right"
},
{
href: "/api/admin",
label: "Admin API",
prependBaseUrlToHref: true,
target: '_blank'
},
{
href: "https://github.com/medusajs/medusa/issues/new?assignees=&labels=type%3A+docs&template=docs.yml",
position: "right",
label: "Report an Issue",
className: "right-divider"
},
target: '_blank',
position: "right"
}
],
},
navbarActions: [
{
type: "link",
href: "https://github.com/medusajs/medusa/issues/new?assignees=&labels=type%3A+docs&template=docs.yml",
title: "Report an Issue",
icon: "report"
}
],
footer: {
logo: {
alt: "Medusa",
src: "img/logo.png",
srcDark: "img/logo-dark.png"
},
links: [
{
title: 'Product',
items: [
{
label: 'Get started',
to: '/quickstart/quick-start'
},
{
label: 'Docs',
to: '/'
},
{
label: 'Store API',
to: '/api/store'
},
{
label: 'Admin API',
to: '/api/admin'
}
]
},
{
title: 'Company',
items: [
{
label: 'Careers',
href: 'https://medusajs.notion.site/Careers-at-Medusa-f986a1d41eb146d888f9590a360547d1'
},
{
label: 'Pricing',
href: 'https://medusajs.com/pricing/'
},
{
label: 'Press Kit',
href: 'https://medusajs.notion.site/Media-Kit-9d885bb679674b458bca316f841322b6'
},
{
label: 'About',
href: 'https://medusajs.notion.site/'
},
{
label: 'Blog',
href: 'https://medusajs.com/blog'
},
{
label: 'Contact',
href: 'https://medusajs.com/contact-us/'
}
]
},
{
title: "Community",
items: [
{
label: "User Trials",
href: "https://ky5eo2x1u81.typeform.com/to/bFCQpY59",
},
{
label: "Stack Overflow",
href: "https://stackoverflow.com/questions/tagged/medusa-commerce",
},
{
label: "Discussions",
href: "https://github.com/medusajs/medusa/discussions",
},
{
label: "Discord",
href: "https://discord.gg/medusajs",
},
],
},
],
copyright: `© ${new Date().getFullYear()} Medusa`,
copyright: `© ${new Date().getFullYear()} Medusa, Inc. All rights reserved.`,
},
socialLinks: [
{
@@ -181,14 +113,23 @@ const config = {
type: 'twitter',
href: 'https://twitter.com/medusajs'
},
{
type: 'linkedin',
href: 'https://www.linkedin.com/company/medusajs'
},
{
type: 'github',
href: 'https://github.com/medusajs/medusa'
},
}
],
reportCodeLinkPrefix: 'https://github.com/medusajs/medusa/issues/new?assignees=&labels=type%3A+docs&template=docs.yml',
footerFeedback: {
event: 'survey'
},
docs: {
sidebar: {
autoCollapseCategories: true
}
}
},
presets: [
@@ -205,11 +146,10 @@ const config = {
],
showLastUpdateTime: true,
// breadcrumbs: false,
// async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) {
// const sidebarItems = await defaultSidebarItemsGenerator(args);
// console.log("here", sidebarItems, args.isCategoryIndex());
// return reverseSidebar(sidebarItems);
// },
async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) {
const sidebarItems = await defaultSidebarItemsGenerator(args);
return reverseSidebar(sidebarItems, args.item);
},
},
theme: {
customCss: require.resolve("./src/css/custom.css")
@@ -241,7 +181,7 @@ const config = {
],
// Theme Options for modifying how redoc renders them
theme: {
primaryColorDark: '#242526',
primaryColorDark: '#161618',
options: {
disableSearch: true,
nativeScrollbars: true,