feat: update documentation from user perspective#12
Merged
Conversation
Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com>
Deploying sync-tooling with
|
| Latest commit: |
2a4320f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a80bd06d.sync-tooling.pages.dev |
| Branch Preview URL: | https://feat-xx1-integration-docs.sync-tooling.pages.dev |
Contributor
Author
|
Please check the differences on real deployment. 
|
Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com>
mojomex
reviewed
Sep 25, 2025
Collaborator
mojomex
left a comment
mojomex
left a comment
There was a problem hiding this comment.
Thank you for the super helpful contributions! Indded there was some stuff that integrators need that I missed.
I have some small feedback about style/navigation but overall this PR is almost there.
Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com>
mojomex
added a commit
that referenced
this pull request
Jan 5, 2026
* docs: start integrators' guide, add PTP architecture tips Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * docs: explanation of PTP setups, SYNC.TOOLING installation Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * chore: fix heading level for SYNC.DOCTOR Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * docs: split huge pages into smaller ones Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * chore: fix links on index page Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * docs: make links, headers of some sections nicer Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * chore: clarify how to access docs in README.md Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * feat: update documentation from user perspective (#12) * update documentation Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com> * add an overall ROS2 architecture Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com> * fix the suggestion on the usage part Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com> * Clean up the created svg in markdown * clean the svg file --------- Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com> --------- Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com> Co-authored-by: Yuxuan Liu <619684051@qq.com>
mojomex
added a commit
that referenced
this pull request
Jan 28, 2026
* docs: start integrators' guide, add PTP architecture tips Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * docs: explanation of PTP setups, SYNC.TOOLING installation Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * chore: fix heading level for SYNC.DOCTOR Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * docs: split huge pages into smaller ones Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * chore: fix links on index page Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * docs: make links, headers of some sections nicer Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * chore: clarify how to access docs in README.md Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * feat: update documentation from user perspective (#12) * update documentation Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com> * add an overall ROS2 architecture Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com> * fix the suggestion on the usage part Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com> * Clean up the created svg in markdown * clean the svg file --------- Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com> --------- Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> Signed-off-by: YuxuanLiuTier4Desktop <619684051@qq.com> Co-authored-by: Yuxuan Liu <619684051@qq.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update some writing, let's check if the documentation built.
The difference is provided in the following comments.
Please also check if my understandings are correct.