Skip to content

Commit a73c5fd

Browse files
committed
docs(roo-rocket/README): update
1 parent 96c786b commit a73c5fd

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

libs/roo-rocket/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# roo-rocket
22

3-
**roo-rocket** is the core engine of `roo-rocket` monorepo, containing all of the core logics that allows you to create and ship your rocket-powered troop (pack of Roo) to the world!
3+
**roo-rocket** is the core engine of `roo-rocket` monorepo, containing all of the core logics that allows you to create and ship your rocket-powered `troop` (dictionary: collective of kangaroos) to the world!
44

55
## Training your troop
66

@@ -9,7 +9,11 @@
99
To start training your own `troop`, `Roo Rocket` requires a `rocket assembly`, which is these components:
1010
* `frame/`: the rocket frame, containing the base files that will be processed and built out, only the listed patterns are allowed:
1111
* `.roomodes`: the `.roomodes` definition to add custom modes for the user.
12-
* `.roo/*`: the `.roo` folder, containing files that will populate/override instructions for Roo modes.
12+
* `.roo/*`: the `.roo` folder, containing files that will populate/override instructions for Roo modes, MCP configs, etc.
1313
* `fuel/`: the rocket fuel, containing the files that will be used as context to build the rocket, feel free to add any files as you need.
1414
* `rocket.config.ts`: the rocket config file, containing the instructions to for `RR` to assemble and allowing customization of the rocket.
15-
* Utilizes `TypeScript` on development side for type safety & autocomplete DX, bundles to `JSON5`.
15+
* Utilizes TypeScript on development side for type safety & autocomplete DX, bundles to JSON5 for safety and human-readability at client-side.
16+
17+
#### `rocket.config.ts` available configurations:
18+
19+
Please refer to [**Typedoc page**](https://namesmt.github.io/config-rocket/interfaces/RocketConfig.html)

0 commit comments

Comments
 (0)