From 587d1450feb9654539df242fe2afe1cab3794a50 Mon Sep 17 00:00:00 2001 From: mamoodi Date: Wed, 15 Oct 2025 09:13:53 -0400 Subject: [PATCH] Add PR template --- .github/pull_request_template.md | 4 ++++ README.md | 11 ++--------- 2 files changed, 6 insertions(+), 9 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..b969d6c9 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,4 @@ +- [ ] I have read and reviewed the documentation changes to the best of my ability. +- [ ] If the change is significant, I have run the documentation site locally and confirmed it renders as expected. + +**Summary of changes** diff --git a/README.md b/README.md index a68ea9f5..a1a4ebf0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# All Hands AI Documentation +# OpenHands Documentation -This repository aggregates documentation from multiple All Hands AI repositories to provide a unified documentation site powered by Mintlify. +This repository provides a unified documentation site powered by Mintlify. ## Structure @@ -10,13 +10,6 @@ This repository aggregates documentation from multiple All Hands AI repositories - `sdk/` - Agent SDK docs. - `success-stories/` - Success stories docs. -## Adding New Documentation Sources - -To add documentation from a new repository: - -1. Add workflow [like this](https://github.com/All-Hands-AI/agent-sdk/blob/main/.github/workflows/deploy-docs.yml) to the new repo. -2. Update `docs.json` to include navigation for the new content (e.g., `new-repo/docs/`) - ## Local Development To run the documentation site locally: