Skip to content

Commit

Permalink
docs: 📝 improve getting started documentation
Browse files Browse the repository at this point in the history
- Add tip box to highlight important information about including source code packages
- Clarify the usage of `groupId:*` in the `includes` configuration
  • Loading branch information
linwumingshi committed Dec 23, 2024
1 parent 20ac3ac commit 1611fa9
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
10 changes: 8 additions & 2 deletions docs/en/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,13 @@ Create the `smart-doc.json` file in the `resources` directory of the module wher
> `outPath` can also use relative paths, such as: `./src/main/resources/static/doc`

Configure the `Maven plug-in` in the `pom.xml` file of the module where the project startup class is located. Note: the source code package that `includes` depends on is required.
Configure the `Maven plug-in` in the `pom.xml` file of the module where the project startup class is located.

:::tip
Note: the source code package that `includes` depends on is required.
:::


```xml
<plugin>
<groupId>com.ly.smart-doc</groupId>
Expand Down Expand Up @@ -49,7 +55,7 @@ Configure the `Maven plug-in` in the `pom.xml` file of the module where the proj
</plugin>

```
> `includes` needs to be adjusted to configure `groupId:artifactId` for the packages that the project module depends on, and supports regular `artifactId:*`
> `includes` needs to be adjusted to configure `groupId:artifactId` for the packages that the project module depends on, and supports regular `groupId:*`

If the project depends on other internal public modules and second-party packages, the dependent packages need to be configured with source code packaging.
Expand Down
7 changes: 6 additions & 1 deletion docs/zh/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,12 @@
> `outPath`也可以使用相对路径, 如: `./src/main/resources/static/doc`

在项目启动类所在模块的`pom.xml`文件配置`Maven插件`, 注意: 需要`includes`依赖的源码包
在项目启动类所在模块的`pom.xml`文件配置`Maven插件`

:::tip
注意: 需要`includes`依赖的源码包
:::

```xml
<plugin>
<groupId>com.ly.smart-doc</groupId>
Expand Down

0 comments on commit 1611fa9

Please sign in to comment.