Merge pull request #204 from 1chooo/docs/#200

Docs/#200

README.md

@@ -1,5 +1,5 @@
 <a href="https://1chooo.com">
-  <img alt="1chooo.com Home Page" src="./apps/web/docs/imgs/cover_transparent_bg.png">
+  <img alt="1chooo.com Home Page" src="https://docs.1chooo.com/images/cover_transparent_bg.png">
 </a>
 
 <h1 align="center"><a href="https://1chooo.com">1chooo.com</a></h1>

apps/docs/pages/_meta.json

@@ -0,0 +1,5 @@
+{
+    "index": "Welcome to 1chooo.com",
+    "contributing": "Contributing",
+    "thanks": "Special Thanks"
+}

apps/web/docs/code-walkthrough/README.md → apps/docs/pages/code-walkthrough.mdx

@@ -1,3 +1,5 @@
+import { FileTree } from 'nextra/components'
+
 # Code Walkthrough
 
 [1chooo.com](https://1chooo.com) is a web application that allows users to showcase their projects and portfolios. This document provides a high-level overview of the codebase and the architecture of the application.
@@ -63,3 +65,17 @@ Estimated People Required (organic) 1.82
 Processed 144774 bytes, 0.145 megabytes (SI)
 ───────────────────────────────────────────────────────────────────────────────
 ```
+
+
+<FileTree>
+  <FileTree.Folder name="pages" defaultOpen>
+    <FileTree.File name="_meta.json" />
+    <FileTree.File name="contact.md" />
+    <FileTree.File name="index.mdx" />
+    <FileTree.Folder name="about">
+      <FileTree.File name="_meta.json" />
+      <FileTree.File name="legal.md" />
+      <FileTree.File name="index.mdx" />
+    </FileTree.Folder>
+  </FileTree.Folder>
+</FileTree>

apps/web/docs/CONTRIBUTING.md → apps/docs/pages/contributing.mdx

@@ -1,23 +1,8 @@
-# Contributing to `1chooo.com`<!-- omit in toc -->
+import { Callout } from 'nextra/components'
 
-Welcome to the [1chooo.com](https://github.com/1chooo/1chooo.com) repository! We're glad you're interested in contributing to our `React` portfolio project. By contributing, you help make our project better and more useful for everyone. Below are some guidelines to get you started.
+# Contributing to `1chooo.com`
 
-## Table of Contents<!-- omit in toc -->
-- [Issues](#issues)
-- [Pull Requests](#pull-requests)
-- [Setup](#setup)
-  - [Forking this Repository:](#forking-this-repository)
-  - [Cloning the Repository to Your Workspace:](#cloning-the-repository-to-your-workspace)
-  - [Setting Upstream Remote:](#setting-upstream-remote)
-  - [Pull Requests:](#pull-requests-1)
-- [Getting Started](#getting-started)
-  - [Available Scripts](#available-scripts)
-    - [`npm start`](#npm-start)
-    - [`npm test`](#npm-test)
-    - [`npm run build`](#npm-run-build)
-    - [`npm run eject`](#npm-run-eject)
-  - [Learn More](#learn-more)
-- [Conventional Commits](#conventional-commits)
+Welcome to the [1chooo.com](https://github.com/1chooo/1chooo.com) repository! We're glad you're interested in contributing to our `React` portfolio project. By contributing, you help make our project better and more useful for everyone. Below are some guidelines to get you started.
 
 ## Issues
 
@@ -64,15 +49,15 @@ upstream        [email protected]:1chooo/1chooo.com.git (push)
 
 If you have any valuable ideas to contribute, please create a pull request and provide details about the outstanding work you've done.
 
+<Callout type="info">
+  **Make sure to synchronize and update your repository before writing any code.**
 
-> [!IMPORTANT]  
-> **Make sure to synchronize and update your repository before writing any code.**
-> 
-> 1. Run `git stash save` to temporarily stash your local changes.
-> 2. Run `git fetch upstream` to sync the source project with your local copy.
-> 3. Run `git checkout main` to switch to the main branch.
-> 4. Run `git merge upstream/main` to merge the updated remote version into your local copy. If there are no conflicts, the update process is complete.
-> 5. Run `git stash pop` to apply your temporarily stashed changes back to your working directory. Resolve any conflicts if necessary.
+  1. Run `git stash save` to temporarily stash your local changes.
+  2. Run `git fetch upstream` to sync the source project with your local copy.
+  3. Run `git checkout main` to switch to the main branch.
+  4. Run `git merge upstream/main` to merge the updated remote version into your local copy. If there are no conflicts, the update process is complete.
+  5. Run `git stash pop` to apply your temporarily stashed changes back to your working directory. Resolve any conflicts if necessary.
+</Callout>
 
 ## Getting Started
 

apps/docs/pages/index.mdx

@@ -1,3 +1,64 @@
-# Welcome to Nextra
+import Link from 'next/link';
+
+# Welcome to 1chooo.com
 
-Hello, world!
+Hello, world! Visit [1chooo.com](https://1chooo.com) for more information.
+
+```ts
+console.log('Hello, world!');
+```
+
+<Link href="https://1chooo.com">
+  <img alt="1chooo.com Home Page" src="/images/cover_transparent_bg.png" />
+</Link>
+
+
+<h3 align="center">
+    <b><i>The Source Code of my Website.</i></b>
+</h3>
+
+<p align="center">
+    <i>Inspired by the <a href="https://github.com/codewithsadee/vcard-personal-portfolio">codewithsadee/vcard-personal-portfolio</a>, we aim to transform the <code>HTML/CSS</code> template into a React with Next.js project.</i>
+</p>
+
+## ✨ Features
+
+- 🚧 Skeleton Loading
+- ⚡️ Next.js 14 with App Router
+- 🟩 GitHub Calendar Heatmap
+- ✍🏻 Markdown Rendering
+- 🧪 Components Unit Testing
+
+## 🌏 Contributing
+
+[PRs](https://github.com/1chooo/1chooo.com/pulls) and [Issues](https://github.com/1chooo/1chooo.com/issues) are welcome! 🫵🏻
+
+Please read the [Contributing Guideline](/contributing) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## 🔩 Getting Started
+
+```shell
+$ git clone [email protected]:1chooo/1chooo.com.git
+$ cd 1chooo.com
+$ npm install
+$ npm run dev   # Open http://localhost:3000 with your browser to see the result.
+```
+
+## 📲 Contact Info
+
+> **Hugo ChunHo Lin**
+> 
+>  - 📩 E-mail: [[email protected]](mailto:[email protected])
+>  - 🧳 Linkedin: [Hugo ChunHo Lin](https://www.linkedin.com/in/1chooo/)
+>  - 👨🏻‍💻 GitHub: [1chooo](https://github.com/1chooo)
+
+## 🪪 License
+
+Released under [MIT](./LICENSE) by [Hugo ChunHo Lin](https://1chooo.com).
+
+This software can be modified and reused without restriction.
+The original license must be included with any copies of this software.
+If a significant portion of the source code is used, please provide a link back to this repository.
+
+
+Made with 🖤 by [@1chooo](https://1chooo.com)