Skip to content

Commit cae3857

Browse files
authored
Generate documentation before running link check (#78)
* Generate documentation before running link check Some links may point to the generated documentation content, which would result in a failure of the link check. It's true that these links are indeed broken when accessed outside the website, but the primary publishing location for this content is the website. The alternative would be checking the generated content into the repository, but this would either require some fairly complex automation or else a burden on the contributors to keep it synced. * Use relative link to command reference in docs It's important to use relative links so that the user's website version selection is retained.
1 parent 8b49417 commit cae3857

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

Taskfile.yml

+7
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ tasks:
2424
cmds:
2525
- poetry run mike deploy --update-aliases --push --remote {{.DOCS_REMOTE}} {{.DOCS_VERSION}} {{.DOCS_ALIAS}}
2626

27+
docs:generate:
28+
desc: Create all generated documentation content
29+
deps:
30+
- task: docs:gen:commands
31+
2732
docs:gen:commands:
2833
desc: Generate command reference files
2934
dir: ./docsgen
@@ -43,6 +48,8 @@ tasks:
4348

4449
docs:check-links:
4550
desc: Verifies there are no dead links in documentation
51+
deps:
52+
- task: docs:generate
4653
cmds:
4754
- |
4855
npx -p markdown-link-check -c '

docs/usage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ The full list of command line options can be obtained with the `-h` option: `./a
5757
For further information you can use the [command reference]
5858

5959
[install]: installation.md
60-
[command reference]: https://arduino.github.io/arduino-fwuploader/dev/commands/arduino-fwuploader/
60+
[command reference]: commands/arduino-fwuploader.md

0 commit comments

Comments
 (0)