Skip to content

docs: fix placeholder links and docs workflow deprecations#515

Merged
okalachev merged 1 commit intoCopterExpress:masterfrom
fly-pigTH:review/high-confidence-pr-fixes
Apr 14, 2026
Merged

docs: fix placeholder links and docs workflow deprecations#515
okalachev merged 1 commit intoCopterExpress:masterfrom
fly-pigTH:review/high-confidence-pr-fixes

Conversation

@fly-pigTH
Copy link
Copy Markdown
Contributor

Summary

  • fill missing documentation links in EN/RU articles
  • replace TODO placeholders in the network articles with a real reference
  • fix the broken VPE link in the optical flow article
  • update the docs workflow to avoid deprecated GitHub Actions output syntax

Validation

  • git diff --check
  • python3 check_assets_size.py
  • python3 check_unused_assets.py
  • parsed .github/workflows/docs.yml locally
  • checked the touched local markdown links

Copy link
Copy Markdown
Member

@okalachev okalachev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi!

Thanks for the documentation fixes! But can you please explain your changes in the workflows?

- 'clover_blocks/**'
- 'clover_description/**'
- 'clover_simulation/**'
- 'roswww_static/**'
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is that for?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a paths filter on the pull_request trigger — the workflow only runs when a PR touches one of the listed ROS package directories. Intent was to skip the image build for docs-only PRs like this one. It's a separate commit (4678375) and doesn't really belong in a docs: PR. I'll revert it here and, if it's still useful, open a separate PR for discussion.

- 'clover_blocks/**'
- 'clover_description/**'
- 'clover_simulation/**'
- 'roswww_static/**'
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same commit, same intent — skip catkin build on docs-only PRs. Reverting together with the other one.

rm _book/clover_en.pdf && mv _book/clover_en_compressed.pdf _book/clover_en.pdf
ls -lah _book/clover*.pdf
echo '::set-output name=GITBOOK_PDF_OK::1'
echo 'GITBOOK_PDF_OK=1' >> "$GITHUB_OUTPUT"
Copy link
Copy Markdown
Member

@okalachev okalachev Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you pls explain this?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

::set-output was deprecated by GitHub Actions on 2022-10-11 and now prints a deprecation warning in the runner log; the replacement is appending name=value to the $GITHUB_OUTPUT file. Behavior is identical — the downstream steps.generate-pdf.outputs.GITBOOK_PDF_OK check still works the same way.

😀 Reference: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

@fly-pigTH fly-pigTH force-pushed the review/high-confidence-pr-fixes branch from 4678375 to 7c5fd6e Compare April 13, 2026 15:05
@okalachev okalachev merged commit 492430e into CopterExpress:master Apr 14, 2026
6 of 10 checks passed
@okalachev
Copy link
Copy Markdown
Member

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants