Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 📝 improve getting started documentation #150

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: 📝 improve getting started documentation #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/en/guide/getting-started.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading