# Development Guide

# Directory structure Docs πŸ“–

β”œβ”€β”€docs
β”‚  β”œβ”€β”€ deploy.sh
β”‚  β”œβ”€β”€ package.json
β”‚  β”œβ”€β”€ src
β”‚  β”‚Β Β  β”œβ”€β”€ public
β”‚  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ image1.png
β”‚  β”‚Β Β  β”‚Β Β  └── image2.png
β”‚  β”‚Β Β  β”œβ”€β”€ .vuepress
β”‚  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ Components
β”‚  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ ABC.vue
β”‚  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ Anchor.vue
β”‚  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── index.js
β”‚  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ Public
β”‚  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ image1.png
β”‚  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── image2.png
β”‚  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ styles
β”‚  β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ abc.css
β”‚  β”‚Β Β  β”‚Β Β  β”‚Β Β  └── xyz.css
β”‚  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ config.js
β”‚  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ enhanceApp.js
β”‚  β”‚Β Β  β”‚Β Β  └── index.js
β”‚  β”‚Β Β  └── Document folder type
β”‚  β”‚Β Β  Β    β”œβ”€β”€ README.md
β”‚  β”‚Β Β  Β Β   └── xyz.md
β”‚  └── tsconfig.json
β”œβ”€β”€README.md
└──yarn.lock

# Writing new documentation πŸ“–

  • Create a folder inside src with the name of the document name
  • Create a README.md file for default page content under the documentation
  • Create multiple files as name.md to create more content on the sidebar of the page
  • Update the config.js inside the .vuepress folder as shown in the below code blocks

# Add to Nav example

  {
    text: 'Developer Guide',
    link: '/developer-guide/'
  }

# Add to sidebar example

'/prismic/': [
  {
    title: 'Prismic',
    collapsable: false,
    children: [
      '',
      'features', // files inside the document folder
    ]
  }
],