docs: switch doc engine to Docusaurus

foldright · Apr 27, 2024 · c6f3c2a · c6f3c2a
1 parent 2d321c9
commit c6f3c2a
Show file tree

Hide file tree

Showing 21 changed files with 43 additions and 648 deletions.
diff --git a/docs.old/book.toml b/docs.old/book.toml
diff --git a/docs.old/src/SUMMARY.md b/docs.old/src/SUMMARY.md
diff --git a/docs.old/src/pipeline-direction.md b/docs.old/src/pipeline-direction.md
diff --git a/docs.old/src/quick-start.md b/docs.old/src/quick-start.md
diff --git a/docs.old/src/readme.md b/docs.old/src/readme.md
diff --git a/docs/docs/tutorial-advanced/01-direction.md b/docs/docs/tutorial-advanced/01-direction.md
@@ -0,0 +1,26 @@
+---
+sidebar_position: 1
+---
+# Pipeline Direction
+
+The auto-pipeline also introduced the `@PipelineDirection` annotation for the pipeline.
+
+## Specify the direction
+
+We can specify the direction on methods or interfaces.
+
+The default direction is `@Direction.FORWARD`, here's the rules:
+
+- Rule1: in the `@AutoPipelin` interface's method, we can:
+    - add `Direction.FORWARD` to apply the interface's method, the annotated method will be called from head to tail
+    - add `Direction.REVERSE` to apply the interface's method, the annotated method will be called from tail to head
+    - if there's no `Direction annotation` to the method, the direction of pipeline will follow the `Direction` in the in the `@AutoPipeline` interface, see rule2
+    - `Direction.FORWARD` and `Direction.REVERSE` are mutually exclusive, they cannot coexist
+- Rule2: in the `@AutoPipeline` interface, we can:
+    - add `Direction.FORWARD` to the `@AutoPipeline` interface, the methods declared in this interface will be called from head to tail unless the method is annotated with `Direction` in the method level
+    - add `Direction.REVERSE` to the `@AutoPipeline` interface, the methods declared in this interface will be called from tail to head unless the method is annotated with `Direction` in the method level
+    - if no `Direction` annotation to the `@AutoPipeline` interface, it equals to add `Direction.FORWARD` to the `@AutoPipeline` interface
+    - `Direction.FORWARD` and `Direction.REVERSE` are mutually exclusive, they cannot coexist
+
+## Direction example
+For examples, please check the [RPC example](https://github.com/foldright/auto-pipeline/blob/main/auto-pipeline-examples/src/main/java/com/foldright/examples/duplexing/RPC.java) and the [test case](https://github.com/foldright/auto-pipeline/blob/main/auto-pipeline-examples/src/test/java/com/foldright/examples/duplexing/pipeline/RPCTest.kt).
diff --git a/docs/docs/tutorial-extras/_category_.json → docs/docs/tutorial-advanced/_category_.json b/docs/docs/tutorial-extras/_category_.json → docs/docs/tutorial-advanced/_category_.json
diff --git a/docs/docs/tutorial-basics/01-quick-start.md b/docs/docs/tutorial-basics/01-quick-start.md
@@ -175,3 +175,4 @@ That's all, the `@AutoPipeline` help you generate the Pipeline Design Pattern Co
 
 ## What's next?
 - check the runnable [test case](https://github.com/foldright/auto-pipeline/blob/main/auto-pipeline-examples/src/test/java/com/foldright/examples/config/pipeline/ConfigSourceTest.kt) for details.
+- check out the [example project](https://github.com/foldright/auto-pipeline/tree/main/auto-pipeline-examples/src/main/java/com/foldright/examples)
diff --git a/docs.old/src/examples.md → docs/docs/tutorial-basics/02-examples.md b/docs.old/src/examples.md → docs/docs/tutorial-basics/02-examples.md
@@ -1,3 +1,8 @@
+---
+sidebar_position: 2
+---
 # Examples
 
 check out the [example project](https://github.com/foldright/auto-pipeline/tree/main/auto-pipeline-examples/src/main/java/com/foldright/examples)
+
+
diff --git a/docs/docs/tutorial-basics/congratulations.md b/docs/docs/tutorial-basics/congratulations.md
diff --git a/docs/docs/tutorial-basics/create-a-blog-post.md b/docs/docs/tutorial-basics/create-a-blog-post.md
diff --git a/docs/docs/tutorial-basics/create-a-document.md b/docs/docs/tutorial-basics/create-a-document.md
diff --git a/docs/docs/tutorial-basics/deploy-your-site.md b/docs/docs/tutorial-basics/deploy-your-site.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -175,3 +175,4 @@ That's all, the `@AutoPipeline` help you generate the Pipeline Design Pattern Co

		## What's next?
		- check the runnable [test case](https://github.com/foldright/auto-pipeline/blob/main/auto-pipeline-examples/src/test/java/com/foldright/examples/config/pipeline/ConfigSourceTest.kt) for details.
		- check out the [example project](https://github.com/foldright/auto-pipeline/tree/main/auto-pipeline-examples/src/main/java/com/foldright/examples)