Skip to content

docs: add integrators' guide, PTP architecture tips#5

Merged
mojomex merged 9 commits into
mainfrom
docs/integrators-guide
Jan 5, 2026
Merged

docs: add integrators' guide, PTP architecture tips#5
mojomex merged 9 commits into
mainfrom
docs/integrators-guide

Conversation

@mojomex
Copy link
Copy Markdown
Collaborator

@mojomex mojomex commented Aug 19, 2025

Add an Integrators' Guide to the documentation. This guide is aimed at teams that are using Pilot.Auto and seek to integrate SYNC.TOOLING into their vehicles. It also includes an introduction to and best practices for PTP.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Aug 20, 2025

Deploying sync-tooling with  Cloudflare Pages  Cloudflare Pages

Latest commit: 21a6d59
Status: ✅  Deploy successful!
Preview URL: https://dbe359b7.sync-tooling.pages.dev
Branch Preview URL: https://docs-integrators-guide.sync-tooling.pages.dev

View logs

@mojomex mojomex changed the title docs: start integrators' guide, add PTP architecture tips docs: add integrators' guide, PTP architecture tips Aug 20, 2025
@mojomex mojomex self-assigned this Aug 20, 2025
@mojomex mojomex requested a review from drwnz August 20, 2025 08:30
@mojomex mojomex force-pushed the docs/integrators-guide branch from 00f9ae5 to ab386cc Compare August 21, 2025 04:26
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
@mojomex mojomex force-pushed the docs/integrators-guide branch from ab386cc to 143390d Compare August 28, 2025 00:53
Owen-Liuyuxuan and others added 2 commits September 30, 2025 20:11
* 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>
@sonarqubecloud
Copy link
Copy Markdown

Copy link
Copy Markdown

@drwnz drwnz left a comment

Choose a reason for hiding this comment

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

LGTM!

@mojomex mojomex merged commit 00d02e4 into main Jan 5, 2026
2 of 3 checks passed
@mojomex mojomex deleted the docs/integrators-guide branch January 5, 2026 07:16
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>
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