Docs: Improve the table of content

jmgwrc · Jul 21, 2022 · 0627746 · 0627746
1 parent bbefe51
commit 0627746
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/docs/utils-reference/SUMMARY.md b/docs/utils-reference/SUMMARY.md
@@ -1,9 +1,11 @@
-- [Utilities](utils-reference/README.md)
-  - [Icons](utils-reference/icons/README.md)
-    - [getAvatarIcon](utils-reference/icons/getAvatarIcon.md)
-    - [getProgressIcon](utils-reference/icons/getProgressIcon.md)
-  - [React hooks](utils-reference/react-hooks/README.md)
-    - [useCachedState](utils-reference/react-hooks/useCachedState.md)
-    - [usePromise](utils-reference/react-hooks/usePromise.md)
-    - [useCachedPromise](utils-reference/react-hooks/useCachedPromise.md)
-    - [useFetch](utils-reference/react-hooks/useFetch.md)
+## Utilities
+
+- [Getting Started](utils-reference/getting-started.md)
+- [Icons](utils-reference/icons/README.md)
+  - [getAvatarIcon](utils-reference/icons/getAvatarIcon.md)
+  - [getProgressIcon](utils-reference/icons/getProgressIcon.md)
+- [React hooks](utils-reference/react-hooks/README.md)
+  - [useCachedState](utils-reference/react-hooks/useCachedState.md)
+  - [usePromise](utils-reference/react-hooks/usePromise.md)
+  - [useCachedPromise](utils-reference/react-hooks/useCachedPromise.md)
+  - [useFetch](utils-reference/react-hooks/useFetch.md)
diff --git a/docs/utils-reference/README.md → docs/utils-reference/getting-started.md b/docs/utils-reference/README.md → docs/utils-reference/getting-started.md
diff --git a/scripts/stitch-docs.js b/scripts/stitch-docs.js
@@ -21,7 +21,7 @@ async function main() {
   const summary = fs.readFileSync(path.join(docs, "SUMMARY.md"), "utf-8");
   const utilsSummary = fs.readFileSync(path.join(docs, "./utils-reference/SUMMARY.md"), "utf-8");
 
-  fs.writeFileSync(path.join(docs, "SUMMARY.md"), summary.replace("---", "---\n\n" + utilsSummary + "\n---"));
+  fs.writeFileSync(path.join(docs, "SUMMARY.md"), summary.replace("---", utilsSummary + "\n---"));
 
   fs.unlinkSync(path.join(docs, "./utils-reference/SUMMARY.md"));
 }