Skip to content

3di: TOC update to include Framework > Middleware - #7409

Open
dmarshant wants to merge 2 commits into
ros2:rollingfrom
3di-for-openrobotics:toc-update-middleware
Open

dmarshant wants to merge 2 commits into
ros2:rollingfrom
3di-for-openrobotics:toc-update-middleware

Conversation

@dmarshant

Copy link
Copy Markdown
Contributor

Description

3di received feedback following the application of the new information architecture that "middleware" information shouldn't be included in the Framework > Client Libraries section, but should be a section of its own. This work is a simple restructure to move the middleware articles into their own subsection of Framework, and includes an update to the metadata list to create a "middleware" area.

Fixes #6825

Did you use Generative AI?

no

Additional Information

Backport to Lyrical

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Article metadata

This pull request contains articles that are missing metadata or articles using metadata values that are not in the configured vocabulary (see tools/enhance.yaml).

source/ROS-Framework.rst

  • Missing .. meta:: fields: experience (optional), content-type (optional)
  • Missing after-title directives: short-description (optional, wrap the opening paragraph), showmeta (optional, add with :order: area, contentType, experience)

source/ROS-Framework/About-Middleware.rst

  • Invalid .. meta:: values: area (required, unknown middleware; allowed: community, contributing, installation, framework, nodes, interfaces, parameters, client-libraries, tools, introspection, analysis, node-management, debugging, builds, visualization, package-documentation, capabilities, simulation, motion-planning, navigation, manipulation, perception; capitalisation is ignored)

source/ROS-Framework/client-libraries/Working-with-Client-Libraries.rst

  • Missing after-title directives: short-description (optional, wrap the opening paragraph)

source/ROS-Framework/middleware/About-Different-Middleware-Vendors.rst

  • Invalid .. meta:: values: area (required, unknown middleware; allowed: community, contributing, installation, framework, nodes, interfaces, parameters, client-libraries, tools, introspection, analysis, node-management, debugging, builds, visualization, package-documentation, capabilities, simulation, motion-planning, navigation, manipulation, perception; capitalisation is ignored)

source/ROS-Framework/middleware/About-Middleware-Implementations.rst

  • Invalid .. meta:: values: area (required, unknown middleware; allowed: community, contributing, installation, framework, nodes, interfaces, parameters, client-libraries, tools, introspection, analysis, node-management, debugging, builds, visualization, package-documentation, capabilities, simulation, motion-planning, navigation, manipulation, perception; capitalisation is ignored)

@dmarshant dmarshant changed the title Toc update middleware 3di: TOC update to include Framework > Middleware Nov 6, 2026
@dmarshant

Copy link
Copy Markdown
Contributor Author

The build fails specifically because I've used a metadata "area" that isn't included in the current YAML file of acceptable values. Part of this commit, though, is an update to that YAML file to include the value.

This branch has not been deployed

No deployments
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.

3di | Apply Information Architecture

1 participant