Skip to content

Update Documentation guidelines - #7389

Open
kacperbojakowski-3di wants to merge 21 commits into
ros2:rollingfrom
kacperbojakowski-3di:update-doc-guidelines
Open

kacperbojakowski-3di wants to merge 21 commits into
ros2:rollingfrom
kacperbojakowski-3di:update-doc-guidelines

Conversation

@kacperbojakowski-3di

Copy link
Copy Markdown
Contributor

Updated the article "Documentation guidelines".

This update is part of #6827.

Description

Related to: ros2/ros2#1725

  • Rewrote the documentation guidelines to follow the new content model and style guide.
  • Added guidance for article metadata, showmeta, and short-description.
  • Clarified :area: ordering (most specific first) and how the primary value is used for related content.
  • Pulled the allowed :area: values from tools/enhance.yaml with literalinclude.
  • Documented ros-related-articles and ros-related-packages.
  • Restructured the formatting section, including clearer bash vs console guidance.
  • Added the FAQ section.

Did you use Generative AI?

Yes, GPT-5 for the FAQ section.

Additional Information

Documentation updates from 3di Information Solutions, agreed with Geoff and Tully.

Backport

To be backported to Lyrical.

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.

3 participants