doc: add e2e_test/generated/README.md (#8104)

💦 Approved-By: richardchien
risingwavelabs · Feb 21, 2023 · f11bb62 · f11bb62
1 parent 4b374c3
commit f11bb62
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -58,6 +58,7 @@ ft.txt
 src/tests/regress/output/*
 src/tests/sync_point/slt/e2e_test
 # generated e2e tests
-e2e_test/generated
+e2e_test/generated/*
+!e2e_test/generated/README.md
 # generated scale tests by `cargo nextest`
 scale-test.tar.zst
diff --git a/e2e_test/generated/README.md b/e2e_test/generated/README.md
@@ -0,0 +1,11 @@
+# Generated e2e tests
+
+## docslt
+
+Generated by 
+
+```bash
+cargo run --bin risedev-docslt
+```
+
+Refer to `src/risedevtool/src/bin/risedev-docslt.rs` for more details.