docs: docs, path (#203)

* add description for deprecated path format

* add path.md

* correct typing for sidebar items

* add sidebar and nav bar item for docs

Author: sghng

.vitepress/config.ts

@@ -17,9 +17,16 @@ export default defineConfig({
       { text: "主页", link: "/" },
       { text: "最近更新", link: "/updates" },
       { text: "分享经验", link: "/contribute" },
+      { text: "参考文档", link: "/docs/path", activeMatch: "/docs/" },
       { text: "技术博客", link: "/blog" },
     ],
-    sidebar,
+    sidebar: {
+      "/docs": {
+        base: "/docs/",
+        items: [{ text: "路径格式", link: "path" }],
+      },
+      "/": { base: "/", items: sidebar }, // least precedence
+    },
     socialLinks: [
       {
         icon: "github",

.vitepress/sidebar.ts

@@ -90,6 +90,10 @@ const experience: DefaultTheme.SidebarItem = {
   ],
 };
 
-const sidebar: DefaultTheme.Sidebar = [gradSchool, studyAbroad, experience];
+const sidebar: DefaultTheme.SidebarItem[] = [
+  gradSchool,
+  studyAbroad,
+  experience,
+];
 
 export default sidebar;

docs/docs/path.md

@@ -0,0 +1,92 @@
+# 路径格式
+
+所有文件采用扁平化的组织形式，不对类型、专业等作任何区分，统一存放在 `docs/` 下。`docs/` 被配置为 VitePress 的根目录，并不出现在 URL 中。因此，飞跃手册经验分享的帖子路径格式为：`/<id>.md`。
+
+## 文件名格式
+
+其中，`<id>` 的格式为 `<surname><first-name-abbr><year>`：
+
+- `<surname>` 为姓氏的全拼写，如「李」姓对应 `li`。使用复姓的，全拼写所有汉字，如「慕容」对应 `murong`。
+- `<first-name-abbr>` 为名的首字母缩写，如单名「明」的，对应 `ming`；双名「小明」的，对应 `xm`；双名以上的，以此类推。
+- `<year>` 为年级的后两位。如入学年份为 2019 年的，对应 `19`。
+
+例如，李小明于 2019 年入学，其分享对应的文件名为 `lixm19.md`。
+
+> [!INFO] 格式来源
+>
+> 这个格式主要启发自南科大邮箱的别名格式，但只取年份的后两位以缩短链接长度。
+
+若是匿名分享，则采用 `anon<year>` 格式。
+
+## 同名同年级情况
+
+若出现同名同年级的情况，或一人有多个投稿的，按上述规则，则文件名也相同，因此需要作出如下区分：
+
+- 先进行第一次投稿的作者，可优先使用标准文件名
+- 主文件名之外，其他的帖子，不管是同一作者还是不同作者，应按时间顺序排列，在后方添加字母后缀，如 `lixm19a`、`lixm19b` 等。
+- 同一作者有多个帖子的，不论投稿时间先后，其研究生项目申请经验分享应始终拥有主文件名（如该作者先于其他同名同年级作者投稿）
+- 同年级的匿名作者，先投稿的可使用默认文件名，其他投稿统一按照时间顺序排列添加字母后缀。
+
+例如，下表中，李小明和李晓民同为 19 级本科生，且按时间顺序（从上到下）进行了表格中列举的投稿，则其文件名应如表所示。
+
+|  作者  | 投稿内容 |  文件名   | 解释                                                                     |
+| :----: | :------: | :-------: | ------------------------------------------------------------------------ |
+| 李小明 | 暑研项目 | `lixm19a` | 此投稿早于同一作者的申请经验分享，但不能使用主文件名                     |
+| 李晓民 | 博士申请 | `lixm19b` | 李小明的第一次投稿更早，且后续也投稿了申请经验，因此这里不能使用主文件名 |
+| 李小明 | 硕士申请 | `lixm19`  | 李小明的第一次投稿更早，因此使用主文件名                                 |
+| 李晓民 | 英语学习 | `lixm19c` | 按时间顺序添加字母后缀                                                   |
+
+在这个例子中，如果李小明后续并没有投稿申请经验，则李晓民的帖子依然可以使用 `lixm19` 作为文件名。我们始终给申请、就业帖子更高优先级。
+
+## 资产路径
+
+若一帖子引用了图片、自定义组件、CSS 等资产，则作出如下目录调整：
+
+```txt
+| <id>/
+|-- index.md
+|-- img1.png
+|-- img2.png
+|-- MyComponent.vue
+|-- style.css
+|-- ...
+```
+
+即，不使用单个文件 `<id>.md`，而是使用一个目录 `<id>/`，在其下存放相关的资产，而帖子本身为 `index.md`。
+
+## ~~已弃用的路径格式~~
+
+> [!WARNING] 已弃用
+>
+> 这一节中描述的路径格式已在 `v3` 中被弃用。
+
+样例：
+
+- `/grad-application/computer-science-and-engineering/[US]-15-yanxiangyi`
+- `/grad-application/finance/financial-engineering/[SG]-16-liyilin`
+- `/oversea-program/semester-program/uc_yangzonghao`
+
+### 路径名
+
+路径格式为：`<type>[/<subtype>]/<department>[/<major>]`，其中
+
+- `<type>` 为帖子类别，如 `grad-application`、`oversea-program` 等。
+- `<subtype>` 为可选的细分类别，如 `英语学习` 下细分 `TOEFL`、`GRE` 等。
+- `<department>` 为院系名称，如 `computer-science-and-engineering`、`microelectronics` 等。
+- `<major>` 为可选的专业名称，当一个院系下有多个专业时使用，如 `biology` 下的 `bioinformatics`、`bioscience` 等。
+
+> [!WARNING] 已弃用
+>
+> 这个格式已被弃用，一来因其过长，二来不应在 URL 中使用 `[]` 等的特殊字符。
+
+### 文件名
+
+文件名格式为：`[<region>]-<year>-<name>`，其中
+
+- `<region>` 为地区代码，如 `US`、`CN`、`HK` 等
+- `<year>` 为年级的后两位数字，如 2019 年入学对应 `19`
+- `<name>` 为姓名的全拼写，如「李小明」对应 `lixiaoming`。
+
+> [!WARNING] 已弃用
+>
+> 这个格式已被弃用，一来因其过长，二来不应在 URL 中使用 `[]` 等的特殊字符。