Skip to content

docs: add document for lidarseg directory#237

Merged
ktro2828 merged 2 commits into
mainfrom
docs/schema
Nov 28, 2025
Merged

docs: add document for lidarseg directory#237
ktro2828 merged 2 commits into
mainfrom
docs/schema

Conversation

@ktro2828

Copy link
Copy Markdown
Collaborator

What

This pull request updates the dataset documentation to clarify the directory structure and add information about optional LiDAR segmentation annotations. The changes improve clarity and provide guidance for datasets that include LiDAR segmentation in the nuScenes format.

Documentation improvements:

  • Updated the dataset directory structure in docs/schema/index.md to indicate that annotation, data, input_bag, and map are directories, and added an optional lidarseg/ directory for LiDAR segmentation annotations.
  • Added a new section describing the LiDAR segmentation annotation format, specifying its compatibility with the nuScenes format and detailing the contents of the lidarseg/annotation/ directory.

Configuration update:

  • Added an extra section to the options in mkdocs.yaml for documentation generation, which may be used for further configuration.

Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Copilot AI review requested due to automatic review settings November 26, 2025 01:52
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 26, 2025

Copilot AI 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.

Pull request overview

This pull request enhances the dataset documentation by adding clarity to the directory structure and introducing information about optional LiDAR segmentation annotations. The changes make it explicit which items are directories and document support for LiDAR segmentation data in the nuScenes format.

Key changes:

  • Clarified directory structure notation by adding trailing slashes to distinguish directories from files
  • Added documentation for the optional lidarseg/ directory and its annotation format
  • Updated mkdocs.yaml configuration with an extra section for documentation generation options

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
mkdocs.yaml Added extra section to mkdocstrings plugin options for future configuration
docs/schema/index.md Updated directory structure notation and added LiDAR segmentation annotation documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/schema/index.md
Comment thread docs/schema/index.md
@ktro2828 ktro2828 merged commit 42b9825 into main Nov 28, 2025
4 of 5 checks passed
@ktro2828 ktro2828 deleted the docs/schema branch November 28, 2025 05:23
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants