Skip to content

docs: fiducial markers guide - #482

Merged
MithraGhlm merged 62 commits into
mainfrom
docs/hand-eye-calibration
Jul 2, 2026
Merged

docs: fiducial markers guide#482
MithraGhlm merged 62 commits into
mainfrom
docs/hand-eye-calibration

Conversation

@MithraGhlm

Copy link
Copy Markdown
Contributor

Description

Initial draft of documentation for camera frame calibration guide.
This PR closes the camera frame calibration guide #479

This PR solves the issue by adding two stand-alone guides to the documentation.
The guide for intrinsic camera calibration already exists.
One guide is about the configuration and the process of recognizing STag marker (WIP) and a second one would be dedicated to calibrating the robot.

Review guidelines

Estimated Time of Review: 10 minutes

Feedback Needed

  • Structure okay?
  • Level of detail appropriate?

@MithraGhlm
MithraGhlm requested a review from domire8 April 21, 2026 11:26

@SprGrf SprGrf left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! First quick review:

Comment thread docs/core/examples/guides/camera-streamer.md Outdated
Comment thread docs/core/examples/guides/stag-marker-detection.md Outdated
Comment thread docs/core/examples/guides/stag-marker-detection.md Outdated
Comment thread docs/core/examples/guides/stag-marker-detection.md Outdated
Comment thread docs/core/examples/guides/stag-marker-detection.md Outdated
Comment thread docs/core/examples/guides/stag-marker-detection.md Outdated
Comment thread docs/core/examples/guides/stag-marker-detection.md Outdated
Comment thread docs/core/examples/guides/stag-marker-detection.md Outdated
Comment thread docs/core/examples/guides/stag-marker-detection.md Outdated
@MithraGhlm
MithraGhlm force-pushed the docs/hand-eye-calibration branch from bec2ef4 to 0613b51 Compare April 27, 2026 11:11
@MithraGhlm

Copy link
Copy Markdown
Contributor Author

@SprGrf Thanks

@MithraGhlm MithraGhlm changed the title docs: Hand-Eye calibration guide #479 docs: Marker detection guide #479 Apr 27, 2026
@MithraGhlm MithraGhlm changed the title docs: Marker detection guide #479 docs: Hand-Eye calibration guide #479 Apr 27, 2026
@MithraGhlm

MithraGhlm commented Apr 28, 2026

Copy link
Copy Markdown
Contributor Author

Should there be a stand alone guide to introduce the Robot Camera Calibration component?
Or is it better to have it in the same docs page?

@SprGrf SprGrf left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice! The backbone is here, some first comments I had while reading:

Comment thread docs/core/examples/guides/hand-eye-calibration.md Outdated
Comment thread docs/core/examples/guides/hand-eye-calibration.md Outdated
Comment thread docs/core/examples/guides/hand-eye-calibration.md Outdated
Comment thread docs/core/examples/guides/hand-eye-calibration.md Outdated
Comment thread docs/core/examples/guides/hand-eye-calibration.md Outdated
Comment thread docs/core/examples/guides/hand-eye-calibration.md Outdated
Comment thread docs/core/examples/guides/hand-eye-calibration.md Outdated
MithraGhlm and others added 3 commits April 29, 2026 11:49
Co-authored-by: Spyros Garyfallidis <spyros@aica.tech>
Co-authored-by: Spyros Garyfallidis <spyros@aica.tech>
Co-authored-by: Spyros Garyfallidis <spyros@aica.tech>
Comment thread docs/core/examples/guides/marker-detection.md Outdated
Comment thread docs/core/examples/guides/hand-eye-calibration.md Outdated
Comment thread docs/core/examples/guides/camera-streamer.md Outdated
Comment thread docs/core/examples/guides/marker-detection.md Outdated
Comment thread docs/core/examples/guides/marker-detection.md Outdated
Comment thread docs/core/examples/guides/fiducial-markers.md Outdated
Comment thread docs/core/examples/guides/fiducial-markers.md Outdated
Comment thread docs/core/examples/guides/fiducial-markers.md Outdated
Comment thread docs/core/examples/guides/hand-eye-calibration.md Outdated
Comment thread docs/core/examples/guides/hand-eye-calibration.md Outdated
Co-authored-by: Dominic Reber <71256590+domire8@users.noreply.github.com>
@MithraGhlm MithraGhlm changed the title docs: Fiducial Markers #479 docs: Hand-Eye calibration guide #479 Jun 10, 2026
@MithraGhlm

Copy link
Copy Markdown
Contributor Author

In order to proceed here, please

  1. Remove the hand-eye-calibration guide from this PR. We'll make a separate PR for it.

Before I change anything there, do you want the existing review comments be preserved or is it acceptable to move it to a new branch and create a fresh PR?

This is what I want to do: (Since the name of this PR is already HE calibration, I'll move the Fiducial Markers to a new PR)

  1. Make a new branch for Fiducial Markers
  2. Delete the fiducial-markers.md file and all media related to it

So the existing PR would be only for HE calibration.

Then I'll open a new PR for the Fiducial Markers and rebase on main.

Is this workflow accepted?

@MithraGhlm

Copy link
Copy Markdown
Contributor Author

Unless we have actual guidelines how we want to improve style and formatting, there is no need increasing the scope of this PR to files that are unrelated to hand-eye calibration. It's good practice to keep scopes of PRs narrow.

I'm not against the changes alltogether, but this is not the place to do it. A reformatting PR would be more appropriate

As you correctly commented once on the #485 (This PR contains all commits from #482, could you untangle this?), I untangled #482 from #485.
The initial problem was due to me forgetting to switch to main before making the new branch. But then I rebased it on the main and the problem was resolved. Now #482 and #485 are 2 different PRs.

So I don't understand what you mean by: increasing the scope of this PR to files that are unrelated to hand-eye calibration. It's good practice to keep scopes of PRs narrow.

Since we don't have any specific guidelines yet, how about just merging the small changes and closing #485, instead of reverting it?

@MithraGhlm MithraGhlm changed the title docs: Hand-Eye calibration guide #479 docs: fiducial markers guide #479 Jun 10, 2026
@MithraGhlm MithraGhlm changed the title docs: fiducial markers guide #479 docs/ fiducial markers guide #479 Jun 10, 2026
@domire8

domire8 commented Jun 11, 2026

Copy link
Copy Markdown
Member

All 4 of my previous review comments are still unresolved

@domire8 domire8 changed the title docs/ fiducial markers guide #479 docs: fiducial markers guide Jun 11, 2026

@domire8 domire8 left a comment

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.

Just two last formatting nitpicks. Otherwise all good!

Comment thread docs/core/examples/guides/fiducial-markers.md
Comment thread docs/core/examples/guides/fiducial-markers.md

@domire8 domire8 left a comment

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.

Alright looks good now! Good work with this 👍

@SprGrf SprGrf left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice work, sorry it took me so long to return to this!

Comment thread docs/core/examples/guides/fiducial-markers.md Outdated
Comment thread docs/core/examples/guides/fiducial-markers.md Outdated
Comment thread docs/core/examples/guides/fiducial-markers.md Outdated
Comment thread docs/core/examples/guides/fiducial-markers.md Outdated
Comment thread docs/core/examples/guides/fiducial-markers.md Outdated
Comment thread docs/core/examples/guides/.vscode/settings.json Outdated
@MithraGhlm

Copy link
Copy Markdown
Contributor Author

Nice work, sorry it took me so long to return to this!

No worries :) It's nice you're back.

Comment thread docs/core/examples/guides/fiducial-markers.md
Comment thread docs/core/examples/guides/fiducial-markers.md Outdated
Comment thread docs/core/examples/guides/.vscode/settings.json Outdated
Comment on lines +238 to +240



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.

Suggested change

@domire8 domire8 left a comment

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.

Yes very nice 👍

@MithraGhlm
MithraGhlm merged commit e89f249 into main Jul 2, 2026
@MithraGhlm
MithraGhlm deleted the docs/hand-eye-calibration branch July 2, 2026 06:20
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.

3 participants