Skip to content

Commit

Permalink
add scaffolding for dev docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jinkang-0 committed May 17, 2024
1 parent 52f71d0 commit eed82d1
Show file tree
Hide file tree
Showing 9 changed files with 61 additions and 1 deletion.
23 changes: 23 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,28 @@ const globalNavbar = [

const adminSidebar = ['/admin/', '/admin/retool', '/admin/legal-server'];

const devSidebar = [
'/dev/',
{
text: 'Client Application',
collapsible: true,
sidebarDepth: 2,
children: [
'/dev/client/auth',
'/dev/client/onboarding',
'/dev/client/listings',
'/dev/client/settings',
],
},
{
text: 'Backend',
collapsible: true,
sidebarDepth: 2,
children: ['/dev/backend/database.md', '/dev/backend/retool.md'],
},
'/dev/deployment',
];

export default defineUserConfig({
title: 'Immigration Justice Project',
description:
Expand All @@ -27,6 +49,7 @@ export default defineUserConfig({
navbar: globalNavbar,
sidebar: {
'/admin': adminSidebar,
'/dev': devSidebar,
},
logo: '/ijp_logo_black.png',
logoDark: '/ijp_logo_white.png',
Expand Down
12 changes: 11 additions & 1 deletion docs/dev/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
# Developer Docs
---
next: /dev/client/auth
---

# Project Overview

## Project Setup

## Known Issues

## Feature Wishlist
5 changes: 5 additions & 0 deletions docs/dev/backend/database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
prev: /dev/client/settings
---

# Database
5 changes: 5 additions & 0 deletions docs/dev/backend/retool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
next: /dev/deployment
---

# Retool
5 changes: 5 additions & 0 deletions docs/dev/client/auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
prev: /dev/
---

# Authentication
1 change: 1 addition & 0 deletions docs/dev/client/listings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Listing Pages
1 change: 1 addition & 0 deletions docs/dev/client/onboarding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Onboarding
5 changes: 5 additions & 0 deletions docs/dev/client/settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
next: /dev/backend/database
---

# Settings Page
5 changes: 5 additions & 0 deletions docs/dev/deployment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
prev: /dev/backend/retool
---

# Deployment

0 comments on commit eed82d1

Please sign in to comment.