Skip to content

docs: add docs for agnocast tracepoint#380

Merged
kobayu858 merged 13 commits intomainfrom
agnocast_node_tracepoints
Apr 7, 2026
Merged

docs: add docs for agnocast tracepoint#380
kobayu858 merged 13 commits intomainfrom
agnocast_node_tracepoints

Conversation

@kobayu858
Copy link
Copy Markdown
Contributor

@kobayu858 kobayu858 commented Mar 18, 2026

Description

Added tracepoint definition documentation for Agnocast. Two new files are created for initialization and runtime tracepoints respectively, and links and descriptions are added to the existing index.md and agnocast.md.

Related links

Notes for reviewers

Pre-review checklist for the PR author

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

  • The PR has been reviewed.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.
  • The PR is ready for merge.

After all checkboxes are checked, anyone who has write access can merge the PR.

Signed-off-by: kobayu858 <yutaro.kobayashi.2@tier4.jp>
Signed-off-by: kobayu858 <yutaro.kobayashi.2@tier4.jp>
Signed-off-by: kobayu858 <yutaro.kobayashi.2@tier4.jp>
@kobayu858 kobayu858 changed the title [DRAFT]fdocs: add base docs for agnocast docs: add base docs for agnocast Mar 27, 2026
@kobayu858 kobayu858 changed the title docs: add base docs for agnocast docs: add docs for agnocast tracepoint Mar 27, 2026
kobayu858 and others added 3 commits March 27, 2026 17:21
Signed-off-by: kobayu858 <yutaro.kobayashi.2@tier4.jp>
Signed-off-by: kobayu858 <yutaro.kobayashi.2@tier4.jp>
@kobayu858 kobayu858 marked this pull request as ready for review March 27, 2026 08:26
@kobayu858 kobayu858 marked this pull request as draft March 27, 2026 08:28
@kobayu858 kobayu858 added deploy-docs documentation Improvements or additions to documentation and removed deploy-docs labels Mar 27, 2026
kobayu858 and others added 3 commits March 27, 2026 17:48
Signed-off-by: kobayu858 <yutaro.kobayashi.2@tier4.jp>
Signed-off-by: kobayu858 <yutaro.kobayashi.2@tier4.jp>
Copy link
Copy Markdown
Contributor

@xygyo77 xygyo77 left a comment

Choose a reason for hiding this comment

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

Since this is still a draft, it might be a bit early to mention this, but one minor point:
Currently, the alphabetical order puts Agnocast before the core features in both the sidebar and the page bottom navigation (Next/Previous).
I think it would be more intuitive to have the core features first, followed by the Agnocast points.

@xygyo77 xygyo77 added the tag:deploy-docs deploy documentation as testing label Mar 31, 2026
Signed-off-by: kobayu858 <yutaro.kobayashi.2@tier4.jp>
@kobayu858 kobayu858 added tag:deploy-docs deploy documentation as testing and removed tag:deploy-docs deploy documentation as testing labels Mar 31, 2026
Signed-off-by: kobayu858 <yutaro.kobayashi.2@tier4.jp>
Signed-off-by: kobayu858 <yutaro.kobayashi.2@tier4.jp>
@kobayu858
Copy link
Copy Markdown
Contributor Author

@xygyo77
I've addressed this as follows.
Changed the trace_points reference in docs/design/.pages to a flat format and added trace_points/.pages to control the page ordering. This change slightly alters the appearance of the Tracepoints section in the sidebar (one less level of nesting).

Background: Why this approach was chosen
In the awesome-pages plugin (v2.9.1), when a parent .pages uses a virtual section structure, the child directory's .pages is ignored. (issues/77)
The v2.9.2 release notes mention "Fix .pages in sections under virtual section 77", but when I upgraded to v2.10.1 and tested, the child .pages was still not respected, and it also caused unintended changes to the existing design, so I decided not to adopt it.
I also considered adding prefixes to file names to control the order, but avoided this approach since it would change the URLs.

Please let me know if you have any thoughts on the above.

@kobayu858 kobayu858 marked this pull request as ready for review March 31, 2026 07:36
@kobayu858 kobayu858 requested a review from xygyo77 March 31, 2026 07:36
@iwatake2222 iwatake2222 mentioned this pull request Mar 31, 2026
5 tasks
Copy link
Copy Markdown
Contributor

@xygyo77 xygyo77 left a comment

Choose a reason for hiding this comment

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

Thanks for the detailed investigation and explanation regarding the awesome-pages plugin issue.

I understand the reason for choosing the flat format to avoid the plugin's bug and preserve the URLs. The change in the sidebar nesting is not a problem.

However, I’ve left a comment on the “File changes” tab. Please take a look at that as well.

Comment thread docs/design/software_architecture/agnocast.md
Signed-off-by: kobayu858 <yutaro.kobayashi.2@tier4.jp>
Copy link
Copy Markdown
Contributor

@xygyo77 xygyo77 left a comment

Choose a reason for hiding this comment

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

LGTM

@xygyo77
Copy link
Copy Markdown
Contributor

xygyo77 commented Apr 6, 2026

@kobayu858
I've approved the PR. Since the CI issue is now resolved, please merge it at your convenience.

@kobayu858 kobayu858 merged commit a0cce98 into main Apr 7, 2026
8 checks passed
@kobayu858 kobayu858 deleted the agnocast_node_tracepoints branch April 7, 2026 03:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation tag:deploy-docs deploy documentation as testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants