Refactoring documentation (#57)

* Refactoring documentation

* Refactoring documentation

* update

docs/.gitignore

@@ -3,7 +3,6 @@
 
 # Production
 /build
-/.docusaurus
 
 # Generated files
 .docusaurus
@@ -19,3 +18,5 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+/.docusaurus

docs/README.md

@@ -10,7 +10,8 @@ Installation
 yarn
 ```
 
-### Local Development
+Local Development
+-----------------
 
 ```console
 yarn start
@@ -19,7 +20,8 @@ yarn start
 This command starts a local development server and opens up a browser window. Most changes are reflected live without
 having to restart the server.
 
-### Build
+Build
+-----
 
 ```console
 yarn build
@@ -28,19 +30,8 @@ yarn build
 This command generates static content into the `build` directory and can be served using any static contents hosting
 service.
 
-### Deployment
+Deployment
+----------
 
-Using SSH:
-
-```console
-USE_SSH=true yarn deploy
-```
-
-Not using SSH:
-
-```console
-GIT_USER=<Your GitHub username> yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the
-`gh-pages` branch.
+We use
+[GitHub Action for automatic site deployment](https://github.com/paion-data/athena/blob/master/.github/workflows/ci-cd.yml).

docs/babel.config.js

@@ -1,3 +1,18 @@
+/**
+ * Copyright 2024 Paion Data
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 module.exports = {
   presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
 };