docs: update (#222)

README.md

@@ -43,7 +43,7 @@ There are many test case management tools available in the market, which can be
 
 Proprietary tools often come with modern, user-friendly interfaces but tend to be cloud-based, which may raise security concerns for some organizations. While some of them do offer on-premises options, these tend to be significantly more expensive.
 
-There are also open-source tools, but many feature older user interfaces that involve frequent page reloads, which can hinder usability.
+There are also open-source tools, but many feature older user interfaces that involve frequent full page reloads, which can hinder usability.
 
 With these challenges in mind, I set out to develop a modern, user-friendly, open-source test case management tool that anyone can use for free in a secure, self-hosted environment.
 

docs/docs/dev/backend.md

@@ -4,22 +4,6 @@ sidebar_position: 2
 
 # Backend
 
-## Environmental variables
-
-:::warning[Strongly Recommended]
-
-Although the system will work with default settings without setting environment variables, it is strongly recommended to set SECRET_KEY in production.
-
-:::
-
-Create `.env` File on `backend/`
-
-```.env
-FRONTEND_ORIGIN=http://localhost:8000
-PORT=8001
-SECRET_KEY=your-secret-key
-```
-
 ## Set up database
 
 ```bash

docs/docs/dev/frontend.md

@@ -4,20 +4,6 @@ sidebar_position: 3
 
 # Frontend
 
-## Environmental variables
-
-:::info
-
-Although the system will work with default settings without setting environment variables, but you can override the settings by setting environment variables.
-
-:::
-
-Create `.env` File on `frontend/`
-
-```
-NEXT_PUBLIC_BACKEND_ORIGIN=http://localhost:8001
-```
-
 ## Start frontend server with dev mode
 
 ```bash

docs/docs/getstarted/environment.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 5
+---
+
+# Override settings
+
+The system will work with default settings without setting environment variables, but you can override the settings by placing `.env` file.
+
+## setting frontend environment variables
+
+Create `.env` File on `frontend/`
+
+```.env title="frontend/.env"
+NEXT_PUBLIC_BACKEND_ORIGIN=http://localhost:8001
+```
+
+## setting backend environment variables
+
+Create `.env` File on `backend/`
+
+:::warning[Strongly Recommended]
+
+It is strongly recommended to set SECRET_KEY in production.
+
+:::
+
+```.env title="backend/.env"
+FRONTEND_ORIGIN=http://localhost:8000
+PORT=8001
+SECRET_KEY=your-secret-key
+```

docs/docs/index.md

@@ -4,4 +4,29 @@ sidebar_position: 1
 
 # UnitTCMS
 
-Open Source Test Case Management System
+Open source test case management system designed for self-hosted use
+
+## Why UnitTCMS
+
+No matter the product, it is difficult to manage all testing with automated tests alone. Depending on the environment, Some portion of testing often involves manual test cases. In my team, we have been managing test cases using Excel. While Excel is a highly versatile tool, it is not specifically designed for test case management, which can make it inconvenient in certain scenarios.
+
+For example,
+
+- writing long test procedures can lead to oversized cells
+- forced horizontal scrolling
+- difficult to attach image files.
+- the Excel file may become heavy
+- Need to aggregate test cases and visualization
+- Not ideal for simultaneous editing by multiple people.
+
+Due to these challenges, it becomes clear that a dedicated tool is necessary when managing a substantial number of manual tests.
+
+## Other tools
+
+There are many test case management tools available in the market, which can be categorized into proprietary and open-source solutions.
+
+Proprietary tools often come with modern, user-friendly interfaces but tend to be cloud-based, which may raise security concerns for some organizations. While some of them do offer on-premises options, these tend to be significantly more expensive.
+
+There are also open-source tools, but many feature older user interfaces that involve frequent full page reloads, which can hinder usability.
+
+With these challenges in mind, I set out to develop a modern, user-friendly, open-source test case management tool that anyone can use for free in a secure, self-hosted environment.

docs/docs/why.md

@@ -1,28 +0,0 @@
----
-sidebar_position: 2
----
-
-# Why UnitTCMS
-
-No matter the product, it is difficult to manage all testing with automated tests alone. Depending on the environment, Some portion of testing often involves manual test cases. In my team, we have been managing test cases using Excel. While Excel is a highly versatile tool, it is not specifically designed for test case management, which can make it inconvenient in certain scenarios.
-
-For example,
-
-- writing long test procedures can lead to oversized cells
-- forced horizontal scrolling
-- difficult to attach image files.
-- the Excel file may become heavy
-- Need to aggregate test cases and visualization
-- Not ideal for simultaneous editing by multiple people.
-
-Due to these challenges, it becomes clear that a dedicated tool is necessary when managing a substantial number of manual tests.
-
-## Other tools
-
-There are many test case management tools available in the market, which can be categorized into proprietary and open-source solutions.
-
-Proprietary tools often come with modern, user-friendly interfaces but tend to be cloud-based, which may raise security concerns for some organizations. While some of them do offer on-premises options, these tend to be significantly more expensive.
-
-There are also open-source tools, but many feature older user interfaces that involve frequent page reloads, which can hinder usability.
-
-With these challenges in mind, I set out to develop a modern, user-friendly, open-source test case management tool that anyone can use for free in a secure, self-hosted environment.