[pull] rolling from ros2:rolling

.devcontainer/devcontainer.json

@@ -0,0 +1,19 @@
+{
+	"name": "ROS 2 Documentation",
+	"build": {
+		"dockerfile": "../docker/image/Dockerfile"
+	},
+	"workspaceMount": "source=${localWorkspaceFolder},target=/tmp/doc_repository,type=bind",
+	"workspaceFolder": "/tmp/doc_repository",
+	"postCreateCommand": "pip3 install --no-warn-script-location --user --break-system-packages -r requirements.txt -c constraints.txt",
+	"features": {
+		"ghcr.io/devcontainers/features/git:1": {}
+	},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"ritwickdey.LiveServer"
+			]
+		}
+	}
+}

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,14 @@
+blank_issues_enabled: true
+contact_links:
+  - name: 🔗 Have a question on how to use ROS?
+    url: https://robotics.stackexchange.com/
+    about: We use Robotics Stack Exchange for general project questions.
+  - name: 🔗 Looking for documentation on active ROS distros?
+    url: https://docs.ros.org/
+    about: The ROS documentation is available at docs.ros.org
+  - name: 🔗 Want to discuss a ROS feature or get the latest ROS news?
+    url: https://discourse.ros.org/
+    about: ROS Discourse is our community discussion forum.
+  - name: 🔗 Do you need real time support from other ROS users?
+    url: https://discord.com/servers/open-robotics-1077825543698927656
+    about: Visit our community Discord server. ROS questions belong in "#ros-help" channel.

.github/ISSUE_TEMPLATE/issue_report.yml

@@ -0,0 +1,69 @@
+name: 📝 Documentation Issue
+description: Report an issue with the ROS 2 documentation
+title: "📝 <Brief Title>"
+labels: ["documentation", "issue"]
+body:
+  - type: markdown
+    attributes:
+      value: "**Required Info:**"
+  - type: checkboxes
+    id: issue_type
+    attributes:
+      label: "Issue Type"
+      description: "Select the type of documentation issue"
+      options:
+        - label: "🐛 Bug / Problem"
+        - label: "✏️ Typo / Grammar"
+        - label: "📖 Outdated Content"
+        - label: "🚀 Enhancement"
+  - type: input
+    id: generative_ai
+    attributes:
+      label: "Generated by Generative AI"
+      description: "If this issue was generated using Generative AI, specify the model (e.g., GitHub Copilot v3.2)"
+    validations:
+      required: false
+  - type: input
+    id: distribution
+    attributes:
+      label: "Distribution"
+      description: |
+        ROS 2 distribution that you found the problem in.
+        e.g) Humble, Jazzy, Rolling, ...
+    validations:
+      required: false
+  - type: textarea
+    id: description
+    attributes:
+      label: "Description"
+      description: "Provide a detailed description of the issue"
+    validations:
+      required: true
+  - type: input
+    id: affected_pages
+    attributes:
+      label: "Affected Pages/Sections"
+      description: "Provide links to the affected documentation pages, if applicable"
+    validations:
+      required: false
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: "Screenshots or Examples (if applicable)"
+      description: "Add any supporting screenshots or logs"
+    validations:
+      required: false
+  - type: textarea
+    id: suggested_fix
+    attributes:
+      label: "Suggested Fix"
+      description: "If you have an idea for a fix, please describe it here"
+    validations:
+      required: false
+  - type: textarea
+    id: additional_context
+    attributes:
+      label: "Additional Context"
+      description: "Any other relevant information"
+    validations:
+      required: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+## Description
+
+<!--
+Please include a summary of the changes and the related issue.
+Highlight any key points or areas of concern.
+-->
+
+<!--
+*Automatically closes linked issue when PR is merged.
+Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.*
+-->
+
+Fixes # (issue)
+
+### Did you use Generative AI?
+
+<!--
+If this pull request was generated using Generative AI, specify the model (e.g., GitHub Copilot v3.2)
+-->
+
+### Additional Information
+
+<!--
+If applicable, provide any additional context or details about the changes.
+-->

.github/workflows/dictionaries.yml

@@ -0,0 +1,20 @@
+name: Check Dictionaries
+
+on:
+  push:
+    paths:
+      - 'codespell_dictionary.txt'
+      - 'codespell_whitelist.txt'
+  pull_request:
+    paths:
+      - 'codespell_dictionary.txt'
+      - 'codespell_whitelist.txt'
+
+jobs:
+  check-dictionaries:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run make check-dictionaries
+        run: |
+          make check-dictionaries || (echo "check-dictionaries failed, run: make sort-dictionaries")

.github/workflows/docker-image.yml

@@ -0,0 +1,27 @@
+name: Build & Run Docker Image
+
+on:
+  pull_request:
+    # Only kick workflow if docker files or this workflow are changed
+    paths:
+      - 'docker/**'
+      - '.github/workflows/docker-image.yml'
+
+jobs:
+  validate:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch full history including branches and tags
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build Docker image
+        run: docker build --rm --build-arg user=$(id -un) --build-arg uid=$(id -u) -f ./docker/image/Dockerfile -t test-image:latest .
+
+      - name: Run container and verify
+        run: |
+          docker run --rm --user $(id -u):$(id -g) -v $(pwd):/tmp/doc_repository test-image:latest

.github/workflows/test.yml

@@ -1,22 +1,115 @@
 name: Test
 
-on: [push, pull_request]
+on: pull_request
 
 jobs:
   test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v4
 
       - name: Setup Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: '3.12'
 
       - name: Install dependencies with pip
-        run: |
-          pip install --no-warn-script-location --user --upgrade -r requirements.txt
-          pip install doc8
+        run: pip install --no-warn-script-location --user -r requirements.txt -c constraints.txt
 
-      - run: make html
-      - run: doc8 --ignore D001 --ignore-path build
+      - name: Test doc8
+        run: make test
+
+      - name: Test doc tools
+        run: make test-tools
+
+  lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies with pip
+        run: pip install --no-warn-script-location --user -r requirements.txt -c constraints.txt
+
+      - name: Lint
+        run: make lint
+
+  spellcheck:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies with pip
+        run: pip install --no-warn-script-location --user -r requirements.txt -c constraints.txt
+
+      - name: Spellcheck
+        run: make spellcheck
+
+  build:
+    needs: [test, lint]
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Setup Graphviz
+        uses: ts-graphviz/setup-graphviz@v2
+
+      - name: Install dependencies with pip
+        run: pip install --no-warn-script-location --user -r requirements.txt -c constraints.txt
+
+      - name: Build the docs
+        run: make html
+
+      - name: Upload document artifacts
+        uses: actions/upload-artifact@v4
+        id: artifact-upload-step
+        with:
+          name: html-artifacts-${{ github.event.pull_request.number }}
+          path: build/html
+          retention-days: 30 # default 90
+          compression-level: 9 # maximum compression, default 6
+          if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn`
+
+      - name: Find HTML artifacts link comment
+        uses: peter-evans/find-comment@v3
+        id: find-comment
+        # Skip if PR from fork
+        if: github.repository == github.event.pull_request.head.repo.full_name
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: "HTML artifacts:"
+
+      - name: Create or update HTML artifacts link comment
+        uses: peter-evans/create-or-update-comment@v4
+        # Skip if PR from fork
+        if: github.repository == github.event.pull_request.head.repo.full_name
+        with:
+          comment-id: ${{ steps.find-comment.outputs.comment-id }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: |
+            HTML artifacts: ${{ steps.artifact-upload-step.outputs.artifact-url }}.
+
+            To view the resulting site:
+            1. Click on the above link to download the artifacts archive
+            2. Extract it
+            3. Open `html-artifacts-${{ github.event.pull_request.number }}/index.html` in your favorite browser
+          edit-mode: replace

.gitignore

@@ -2,3 +2,5 @@ build/
 _build/
 .idea/
 .vscode/
+__pycache__
+ros2doc/

.mergify.yml

@@ -2,12 +2,13 @@ pull_request_rules:
   - name: automatic backport of common pages
     conditions:
       - base=rolling
-      - "files~=Governance|Contact|index|Marketing|ROSCon-Content|Roadmap|Releases|Feature-Ideas"
+      - "files~=Governance|Contact|index|Marketing|ROSCon-Content|Roadmap|Releases|Feature-Ideas|Metrics"
     actions:
       backport:
         branches:
-          - galactic
-          - foxy
+          - kilted 
+          - jazzy
+          - humble
 
   - name: backport at reviewers discretion
     conditions:
@@ -16,23 +17,33 @@ pull_request_rules:
     actions:
       backport:
         branches:
-          - galactic
-          - foxy
+          - kilted
+          - jazzy
+          - humble
 
-  - name: backport to galactic at reviewers discretion
+  - name: backport to kilted at reviewers discretion
     conditions:
       - base=rolling
-      - "label=backport-galactic"
+      - "label=backport-kilted"
     actions:
       backport:
         branches:
-          - galactic
+          - kilted
 
-  - name: backport to foxy at reviewers discretion
+  - name: backport to jazzy at reviewers discretion
     conditions:
       - base=rolling
-      - "label=backport-foxy"
+      - "label=backport-jazzy"
     actions:
       backport:
         branches:
-          - foxy
+          - jazzy
+
+  - name: backport to humble at reviewers discretion
+    conditions:
+      - base=rolling
+      - "label=backport-humble"
+    actions:
+      backport:
+        branches:
+          - humble

.sphinx_tamer.yaml

@@ -0,0 +1,11 @@
+sentence_scan:
+    extra_patterns:
+    - Steven! Ragnar
+    - ros2.org
+    - nav2.org
+    - ros2.repos
+    - 2.X
+    - (\s|^)(\.)(idl|msg|srv|action|NET|rviz)
+    - (\s|^)(\.)(tgz|exe|zip|so|repo)
+    ignorable_prefixes:
+    - Releases/

LICENSE

@@ -49,7 +49,7 @@ exhaustive, and do not form part of our licenses.
      such as asking that all changes be marked or described.
      Although not required by our licenses, you are encouraged to
      respect those requests where reasonable. More considerations
-     for the public: 
+     for the public:
     wiki.creativecommons.org/Considerations_for_licensees
 
 =======================================================================