Skip to content

Revamp the documentation#324

Merged
artivis merged 55 commits intodevelfrom
fix/doc
Mar 26, 2025
Merged

Revamp the documentation#324
artivis merged 55 commits intodevelfrom
fix/doc

Conversation

@artivis
Copy link
Owner

@artivis artivis commented Mar 19, 2025

Completely revamp the documentation.

Closes #254
Closes #256
Closes #321

@artivis artivis self-assigned this Mar 19, 2025
@artivis artivis marked this pull request as ready for review March 25, 2025 18:30
@artivis artivis requested a review from joansola March 25, 2025 18:30
@artivis
Copy link
Owner Author

artivis commented Mar 25, 2025

@joansola Could you please review/approve this PR ? But do not merge yet .

@joansola
Copy link
Collaborator

joansola commented Mar 26, 2025

Some things to final check before merge:

  • The table of group operations is complete. For example, what about vee?
  • The order of parts in the Jacobians is correct for all groups
    • SE2
    • SE3
    • SE23
    • SGal3
  • Add an example of Ceres Jacobian compared to manif Jacobian, at least stating matrix sizes (not the actual math). For example, say that SO3d.Inverse() has a 3x3 Jac in manif, but since it is implemented by a quaternion, it has a 4x4 Jacobian if using ceres::Jet.
  • I am not sure if the proper doc website should be complete by this PR. It seems it is lagging behind this PR by quite a bit, no?

Copy link
Collaborator

@joansola joansola left a comment

Choose a reason for hiding this comment

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

see comment about last checks on the PR thread

@artivis
Copy link
Owner Author

artivis commented Mar 26, 2025

I'll double check the order of parts but I'm not going to add any new content to this PR. It was initially only for migrating from the old broken state to a new and shiny website and it's already be taking way more time than I had hoped.
I still have to see if the actual deployment of this new website is working fine - that is, by merging this PR.
Feel free to open an issue where we can list all documentation misses, so that we address them in subsequent PRs.

@joansola
Copy link
Collaborator

Sounds good to me! Sorry for being so picky :-D

@joansola
Copy link
Collaborator

However, and sorry again @artivis . I checked the render in Safari and there's an issue. Maybe you want to merge anyway and I'll open an issue for this. But here it goes:

The operations table is not good. In the devel branch it is OK, but in the fix/doc branch here's how it looks like:

imagen

so most parts of the latex expressions are missing!

In Firefox it all looks good.

@artivis
Copy link
Owner Author

artivis commented Mar 26, 2025

Sounds good to me! Sorry for being so picky :-D

Jajaja don't worry, on the contrary thanks for the effort 🦾 .

I checked the render in Safari and there's an issue.

That's weird. I'll give it a quick search but it may have to wait for another PR.

@joansola
Copy link
Collaborator

That's weird. I'll give it a quick search but it may have to wait for another PR.

I agree to leave it for a separate PR.

artivis added 17 commits March 26, 2025 19:57
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
Signed-off-by: artivis <deray.jeremie@gmail.com>
@artivis
Copy link
Owner Author

artivis commented Mar 26, 2025

@joansola I've updated the Tangent spaces table. It is a little bit of a mess in restrospective 😅 .
I've also ordered the group elements column without specifying it since it's not exactly a one-to-one mapping (R != q).

Mind that I force-pushed to get rid of a conflict. You may want to pull clean to avoid any issue locally.

To me the PR is ready as is. If you agree (and approve this PR), I'll merge and we can eventually improve the doc in follow up PRs (e.g. there is plenty of work to make doxygen happy ...).

Copy link
Collaborator

@joansola joansola left a comment

Choose a reason for hiding this comment

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

Revision OK!

@artivis artivis merged commit 1abdc04 into devel Mar 26, 2025
39 checks passed
@artivis artivis deleted the fix/doc branch March 26, 2025 21:47
@artivis
Copy link
Owner Author

artivis commented Mar 26, 2025

There it is, the new documentation website is live at artivis.github.io/manif !

@joansola
Copy link
Collaborator

Great job @artivis !!!

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

Projects

None yet

2 participants