Skip to content

Commit 6fe8fe6

Browse files
committed
Add usage notes to readme
1 parent 7430892 commit 6fe8fe6

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ jobs:
4747
4848
Once this workflow is executed, the `docs` directory with documentation will be added (or updated if necessary) to your repository. Optionally, you can set up GitHub Pages for your repository to have documentation available at yourname.github.io/yourmodule.
4949

50+
It's worth noting that the action output depends on the V `doc` tool, so consider using a stable V version in your workflow (see the `v-version` input of `nocturlab/setup-vlang-action` action) to make sure generated documentation is consistent and has no issues (or they are known or minor).
51+
5052
### Inputs
5153

5254
#### Required inputs

0 commit comments

Comments
 (0)