docs: change script into documentation generate cli for more advanced options (#60)

* make cli

* works

Author: seokju-na

.github/CONTRIBUTING.md

@@ -37,6 +37,9 @@ just setup
 ### Development Commands
 
 ```shell
+# Build project
+just build
+
 # Format all files
 just format
 
@@ -80,20 +83,5 @@ chore: upgrade vitest to v3
 
 This project aims to maintain high documentation quality.
 
-Please refer to the following guide to create robust references using JSDoc.
-
-- `@category` : Specifies the category in which the reference documentation will be placed. You can use `/` to specify depth (e.g. `Repository/Methods`).
-- `@signature` : Describes what type of signature a function or method has. Please write a type declaration in the TypeScript language.
-- `@param` : Write all parameters.
-- `@returns` : Specifies what value is returned.
-- `@throws` : Write documentation for errors that should be noted.
-- `@example` : Examples are not required, but are recommended as they make the behavior easier to understand.
-
-To automatically generate reference documentation after writing a JSDoc, please run the command below.
+Please refer to [docs/README.md](../docs/README.md) for instructions on writing documentation.
 
-```shell
-yarn build
-
-cd docs/
-yarn gen-reference
-```

.yarnrc.yml

@@ -2,6 +2,6 @@ enableGlobalCache: true
 
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.6.0.cjs
-
 preferReuse: true
+
+yarnPath: .yarn/releases/yarn-4.6.0.cjs

docs/README.md

@@ -0,0 +1,27 @@
+# Documentation
+
+## Writing JSDoc
+
+Use following tags to create robust references using JSDoc.
+
+- `@category` : Specifies the category in which the reference documentation will be placed. You can use `/` to specify depth (e.g. `Repository/Methods`).
+- `@signature` : Describes what type of signature a function or method has. Please write a type declaration in the TypeScript language.
+- `@param` : Write all parameters.
+- `@returns` : Specifies what value is returned.
+- `@throws` : Write documentation for errors that should be noted.
+- `@example` : Examples are not required, but are recommended as they make the behavior easier to understand.
+
+## Generate Reference
+
+To automatically generate reference documentations after writing a JSDoc, please run the command below.
+
+```shell
+# Generate all reference documentations.
+just gen-docs reference
+
+# Generate all korean reference docuementations.
+just gen-docs reference --lang=ko
+
+# Generate specific reference documentations with glob pattern.
+just gen-docs reference --pattern='Tree/Methods/*'
+```