From 3f3a1cac79e57a20ff83503a9b179e80ed6e3b8d Mon Sep 17 00:00:00 2001 From: Jaemin Choi <1dotolee@gmail.com> Date: Sat, 11 May 2024 01:15:16 -0700 Subject: [PATCH] refactor: split dev and user guide --- .vitepress/config.ts | 142 +++++++++--------- .../intro}/assets/backend-preview.png | Bin {intro => dev/intro}/assets/bruno-env.png | Bin {intro => dev/intro}/assets/bruno-select.png | Bin {intro => dev/intro}/assets/bruno-start.png | Bin {intro => dev/intro}/assets/codedang.png | Bin .../intro}/assets/frontend-preview.png | Bin {intro => dev/intro}/assets/git-clone.png | Bin {intro => dev/intro}/assets/graphql-docs.png | Bin .../intro}/assets/new-wsl-window.png | Bin .../intro}/assets/remote-containers.png | Bin {intro => dev/intro}/assets/remote-wsl.png | Bin .../intro}/assets/reopen-in-container.png | Bin .../intro}/assets/vscode-download.png | Bin {intro => dev/intro}/bruno.md | 0 {intro => dev/intro}/getting-started.md | 0 {intro => dev/intro}/index.md | 0 .../project}/assets/deploy-pipeline.png | Bin .../project}/assets/github-actions-runner.png | Bin .../project}/assets/github-projects.png | Bin {project => dev/project}/deploy.md | 0 {project => dev/project}/hierarchy.md | 0 {project => dev/project}/roadmap.md | 0 {project => dev/project}/stage-server.md | 0 {project => dev/project}/tech-stack.md | 0 index.md | 8 +- .../assets/group-approval.png | Bin .../assets/group-config-detail.png | Bin .../assets/group-create-detail.png | Bin {group-admin => user}/assets/group-detail.png | Bin {group-admin => user}/assets/group-member.png | Bin {group-admin => user}/assets/management.png | Bin {group-admin => user}/assets/myGroup.png | Bin .../assets/problem-create-detail.png | Bin .../assets/problem-create.png | Bin {group-admin => user}/group.md | 0 {group-admin => user}/login.md | 0 {group-admin => user}/problem.md | 0 38 files changed, 79 insertions(+), 71 deletions(-) rename {intro => dev/intro}/assets/backend-preview.png (100%) rename {intro => dev/intro}/assets/bruno-env.png (100%) rename {intro => dev/intro}/assets/bruno-select.png (100%) rename {intro => dev/intro}/assets/bruno-start.png (100%) rename {intro => dev/intro}/assets/codedang.png (100%) rename {intro => dev/intro}/assets/frontend-preview.png (100%) rename {intro => dev/intro}/assets/git-clone.png (100%) rename {intro => dev/intro}/assets/graphql-docs.png (100%) rename {intro => dev/intro}/assets/new-wsl-window.png (100%) rename {intro => dev/intro}/assets/remote-containers.png (100%) rename {intro => dev/intro}/assets/remote-wsl.png (100%) rename {intro => dev/intro}/assets/reopen-in-container.png (100%) rename {intro => dev/intro}/assets/vscode-download.png (100%) rename {intro => dev/intro}/bruno.md (100%) rename {intro => dev/intro}/getting-started.md (100%) rename {intro => dev/intro}/index.md (100%) rename {project => dev/project}/assets/deploy-pipeline.png (100%) rename {project => dev/project}/assets/github-actions-runner.png (100%) rename {project => dev/project}/assets/github-projects.png (100%) rename {project => dev/project}/deploy.md (100%) rename {project => dev/project}/hierarchy.md (100%) rename {project => dev/project}/roadmap.md (100%) rename {project => dev/project}/stage-server.md (100%) rename {project => dev/project}/tech-stack.md (100%) rename {group-admin => user}/assets/group-approval.png (100%) rename {group-admin => user}/assets/group-config-detail.png (100%) rename {group-admin => user}/assets/group-create-detail.png (100%) rename {group-admin => user}/assets/group-detail.png (100%) rename {group-admin => user}/assets/group-member.png (100%) rename {group-admin => user}/assets/management.png (100%) rename {group-admin => user}/assets/myGroup.png (100%) rename {group-admin => user}/assets/problem-create-detail.png (100%) rename {group-admin => user}/assets/problem-create.png (100%) rename {group-admin => user}/group.md (100%) rename {group-admin => user}/login.md (100%) rename {group-admin => user}/problem.md (100%) diff --git a/.vitepress/config.ts b/.vitepress/config.ts index c12d0af..e99f66e 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -39,8 +39,12 @@ export default defineConfig({ }, nav: [ { - text: 'Guide', - link: '/intro/' + text: 'For Developers', + link: '/dev/intro/' + }, + { + text: 'For Users', + link: '/user/login' }, { text: 'Codedang', @@ -48,71 +52,75 @@ export default defineConfig({ } ], socialLinks: [{ icon: 'github', link: 'https://github.com/skkuding/next' }], - sidebar: [ - { - text: 'Introduction', - items: [ - { - text: '코드당이 뭔가요?', - link: '/intro/' - }, - { - text: '시작하기', - link: '/intro/getting-started' - }, - { - text: 'Contributing Guide', - link: 'https://github.com/skkuding/next/blob/main/CONTRIBUTING.md' - }, - { - text: 'API 문서', - link: '/intro/bruno' - } - ] - }, - { - text: 'Project', - items: [ - { - text: '기술 스택', - link: '/project/tech-stack' - }, - { - text: '프로젝트 구조', - link: '/project/hierarchy' - }, - { - text: '배포 과정', - link: '/project/deploy' - }, - { - text: 'Staging vs Production', - link: '/project/stage-server' - }, - { - text: 'Project Roadmap', - link: '/project/roadmap' - } - ] - }, - { - text: '관리자 매뉴얼', - items: [ - { - text: '가입 및 로그인', - link: '/group-admin/login' - }, - { - text: '그룹 및 멤버 관리', - link: '/group-admin/group' - }, - { - text: '문제 생성 및 관리', - link: '/group-admin/problem' - } - ] - } - ] + sidebar: { + '/dev/': [ + { + text: 'Introduction', + items: [ + { + text: '코드당이 뭔가요?', + link: '/dev/intro/' + }, + { + text: '시작하기', + link: '/dev/intro/getting-started' + }, + { + text: 'Contributing Guide', + link: 'https://github.com/skkuding/next/blob/main/CONTRIBUTING.md' + }, + { + text: 'API 문서', + link: '/dev/intro/bruno' + } + ] + }, + { + text: 'Project', + items: [ + { + text: '기술 스택', + link: '/dev/project/tech-stack' + }, + { + text: '프로젝트 구조', + link: '/dev/project/hierarchy' + }, + { + text: '배포 과정', + link: '/dev/project/deploy' + }, + { + text: 'Staging vs Production', + link: '/dev/project/stage-server' + }, + { + text: 'Project Roadmap', + link: '/dev/project/roadmap' + } + ] + } + ], + '/user/': [ + { + text: '관리자', + items: [ + { + text: '가입 및 로그인', + link: '/user/login' + }, + { + text: '그룹 및 멤버 관리', + link: '/user/group' + }, + { + text: '문제 생성 및 관리', + link: '/user/problem' + } + ] + } + ] + } }, vite: { server: { diff --git a/intro/assets/backend-preview.png b/dev/intro/assets/backend-preview.png similarity index 100% rename from intro/assets/backend-preview.png rename to dev/intro/assets/backend-preview.png diff --git a/intro/assets/bruno-env.png b/dev/intro/assets/bruno-env.png similarity index 100% rename from intro/assets/bruno-env.png rename to dev/intro/assets/bruno-env.png diff --git a/intro/assets/bruno-select.png b/dev/intro/assets/bruno-select.png similarity index 100% rename from intro/assets/bruno-select.png rename to dev/intro/assets/bruno-select.png diff --git a/intro/assets/bruno-start.png b/dev/intro/assets/bruno-start.png similarity index 100% rename from intro/assets/bruno-start.png rename to dev/intro/assets/bruno-start.png diff --git a/intro/assets/codedang.png b/dev/intro/assets/codedang.png similarity index 100% rename from intro/assets/codedang.png rename to dev/intro/assets/codedang.png diff --git a/intro/assets/frontend-preview.png b/dev/intro/assets/frontend-preview.png similarity index 100% rename from intro/assets/frontend-preview.png rename to dev/intro/assets/frontend-preview.png diff --git a/intro/assets/git-clone.png b/dev/intro/assets/git-clone.png similarity index 100% rename from intro/assets/git-clone.png rename to dev/intro/assets/git-clone.png diff --git a/intro/assets/graphql-docs.png b/dev/intro/assets/graphql-docs.png similarity index 100% rename from intro/assets/graphql-docs.png rename to dev/intro/assets/graphql-docs.png diff --git a/intro/assets/new-wsl-window.png b/dev/intro/assets/new-wsl-window.png similarity index 100% rename from intro/assets/new-wsl-window.png rename to dev/intro/assets/new-wsl-window.png diff --git a/intro/assets/remote-containers.png b/dev/intro/assets/remote-containers.png similarity index 100% rename from intro/assets/remote-containers.png rename to dev/intro/assets/remote-containers.png diff --git a/intro/assets/remote-wsl.png b/dev/intro/assets/remote-wsl.png similarity index 100% rename from intro/assets/remote-wsl.png rename to dev/intro/assets/remote-wsl.png diff --git a/intro/assets/reopen-in-container.png b/dev/intro/assets/reopen-in-container.png similarity index 100% rename from intro/assets/reopen-in-container.png rename to dev/intro/assets/reopen-in-container.png diff --git a/intro/assets/vscode-download.png b/dev/intro/assets/vscode-download.png similarity index 100% rename from intro/assets/vscode-download.png rename to dev/intro/assets/vscode-download.png diff --git a/intro/bruno.md b/dev/intro/bruno.md similarity index 100% rename from intro/bruno.md rename to dev/intro/bruno.md diff --git a/intro/getting-started.md b/dev/intro/getting-started.md similarity index 100% rename from intro/getting-started.md rename to dev/intro/getting-started.md diff --git a/intro/index.md b/dev/intro/index.md similarity index 100% rename from intro/index.md rename to dev/intro/index.md diff --git a/project/assets/deploy-pipeline.png b/dev/project/assets/deploy-pipeline.png similarity index 100% rename from project/assets/deploy-pipeline.png rename to dev/project/assets/deploy-pipeline.png diff --git a/project/assets/github-actions-runner.png b/dev/project/assets/github-actions-runner.png similarity index 100% rename from project/assets/github-actions-runner.png rename to dev/project/assets/github-actions-runner.png diff --git a/project/assets/github-projects.png b/dev/project/assets/github-projects.png similarity index 100% rename from project/assets/github-projects.png rename to dev/project/assets/github-projects.png diff --git a/project/deploy.md b/dev/project/deploy.md similarity index 100% rename from project/deploy.md rename to dev/project/deploy.md diff --git a/project/hierarchy.md b/dev/project/hierarchy.md similarity index 100% rename from project/hierarchy.md rename to dev/project/hierarchy.md diff --git a/project/roadmap.md b/dev/project/roadmap.md similarity index 100% rename from project/roadmap.md rename to dev/project/roadmap.md diff --git a/project/stage-server.md b/dev/project/stage-server.md similarity index 100% rename from project/stage-server.md rename to dev/project/stage-server.md diff --git a/project/tech-stack.md b/dev/project/tech-stack.md similarity index 100% rename from project/tech-stack.md rename to dev/project/tech-stack.md diff --git a/index.md b/index.md index 4bb63e8..0d7dc5a 100644 --- a/index.md +++ b/index.md @@ -10,11 +10,11 @@ hero: alt: Codedang Logo actions: - theme: brand - text: Get Started - link: /intro/ + text: For Developers + link: /dev/intro/ - theme: alt - text: View on GitHub - link: https://github.com/skkuding/next + text: For Users + link: /user/login features: - title: 👍 Easy to use diff --git a/group-admin/assets/group-approval.png b/user/assets/group-approval.png similarity index 100% rename from group-admin/assets/group-approval.png rename to user/assets/group-approval.png diff --git a/group-admin/assets/group-config-detail.png b/user/assets/group-config-detail.png similarity index 100% rename from group-admin/assets/group-config-detail.png rename to user/assets/group-config-detail.png diff --git a/group-admin/assets/group-create-detail.png b/user/assets/group-create-detail.png similarity index 100% rename from group-admin/assets/group-create-detail.png rename to user/assets/group-create-detail.png diff --git a/group-admin/assets/group-detail.png b/user/assets/group-detail.png similarity index 100% rename from group-admin/assets/group-detail.png rename to user/assets/group-detail.png diff --git a/group-admin/assets/group-member.png b/user/assets/group-member.png similarity index 100% rename from group-admin/assets/group-member.png rename to user/assets/group-member.png diff --git a/group-admin/assets/management.png b/user/assets/management.png similarity index 100% rename from group-admin/assets/management.png rename to user/assets/management.png diff --git a/group-admin/assets/myGroup.png b/user/assets/myGroup.png similarity index 100% rename from group-admin/assets/myGroup.png rename to user/assets/myGroup.png diff --git a/group-admin/assets/problem-create-detail.png b/user/assets/problem-create-detail.png similarity index 100% rename from group-admin/assets/problem-create-detail.png rename to user/assets/problem-create-detail.png diff --git a/group-admin/assets/problem-create.png b/user/assets/problem-create.png similarity index 100% rename from group-admin/assets/problem-create.png rename to user/assets/problem-create.png diff --git a/group-admin/group.md b/user/group.md similarity index 100% rename from group-admin/group.md rename to user/group.md diff --git a/group-admin/login.md b/user/login.md similarity index 100% rename from group-admin/login.md rename to user/login.md diff --git a/group-admin/problem.md b/user/problem.md similarity index 100% rename from group-admin/problem.md rename to user/problem.md