From 0ec7f3d69765ac926ce14646b613431d08789af0 Mon Sep 17 00:00:00 2001 From: Josh Date: Fri, 12 Jun 2026 11:12:38 +0100 Subject: [PATCH 1/2] Update README to clarify usage of the GitHub action --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7f977d4..609731f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Arm Docs GitHub Action -This repository contains GitHub Actions for validating and publishing Arm documentation sites with `docs-action`. +This repository contains internal GitHub Actions used by Arm product teams to validate and publish documentation sites to [developer.arm.com](https://developer.arm.com/). Application developers need clear, high quality documentation that helps them succeed on Arm hardware and with Arm tools more quickly. Product documentation should help users complete the task in front of them, without distracting them with unnecessary surrounding context. @@ -8,7 +8,7 @@ This documentation system exists to give product teams a common way to publish d Each product team maintains its own documentation in its own repository and publishes its own independent documentation site. The shared part of the system is not a single combined site, but a common documentation generator and publishing model used across products. -This GitHub action is the entry point for teams to publish their docs to a shared documentation portal under developer.arm.com in a way that is decentralised and easy to use. +This GitHub action is the entry point for teams to publish their docs to a shared documentation portal under [developer.arm.com](https://developer.arm.com/) in a way that is decentralised and easy to use. The actions, workflows, and publishing model in this repository are designed for Arm-owned documentation repositories and Arm's internal publishing process. ## Usage From e083e3100b75ea864f020c0eec5ca5347d83253e Mon Sep 17 00:00:00 2001 From: joshjennings98 Date: Fri, 12 Jun 2026 11:14:09 +0100 Subject: [PATCH 2/2] newsfile --- changes/20260612111348.misc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changes/20260612111348.misc diff --git a/changes/20260612111348.misc b/changes/20260612111348.misc new file mode 100644 index 0000000..fecb9ba --- /dev/null +++ b/changes/20260612111348.misc @@ -0,0 +1 @@ +:gear: Update documentation to clarify usage of the GitHub action