From 05b358b79d3eee81f4bc48bb685674fe1538e1f4 Mon Sep 17 00:00:00 2001 From: Mike Odnis Date: Sun, 27 Sep 2026 21:33:27 -0400 Subject: [PATCH] chore(compliance): relicense to Apache-2.0 and add security and accessibility statements - LICENSE is now the org's Apache-2.0 text, matching the README badge, the SPDX headers and the OpenAPI specs; the Mintlify starter template's MIT licence moves to THIRD_PARTY_NOTICES.md. - Add a root SECURITY.md that points at the org policy and carries the CRA reporting and safe-harbour sections. - Add ACCESSIBILITY.md (WCAG 2.2 AA target, not yet audited) and link it from the site footer. - Soften the home-page "Stay legal" card (all five locales) and the C++ geofencing summary to what the docs show today. - Stop tracking .claude/settings.local.json and ignore it. - Keep the new repo documents off the site and out of the locale parity check. --- .claude/settings.local.json | 9 -- .gitignore | 3 + .mintignore | 5 + ACCESSIBILITY.md | 26 ++++ LICENSE | 222 ++++++++++++++++++++++++++++--- README.md | 2 + SECURITY.md | 39 ++++++ THIRD_PARTY_NOTICES.md | 29 ++++ ar/index.mdx | 7 +- docs.json | 13 +- es/index.mdx | 7 +- hi/index.mdx | 7 +- index.mdx | 6 +- scripts/i18n_parity.py | 9 +- sdks/cpp/api/resq-common/resq.md | 2 +- zh/index.mdx | 6 +- 16 files changed, 343 insertions(+), 49 deletions(-) delete mode 100644 .claude/settings.local.json create mode 100644 ACCESSIBILITY.md create mode 100644 SECURITY.md create mode 100644 THIRD_PARTY_NOTICES.md diff --git a/.claude/settings.local.json b/.claude/settings.local.json deleted file mode 100644 index 9caefb87..00000000 --- a/.claude/settings.local.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "permissions": { - "allow": [ - "Bash(python3:*)", - "Bash(npx --yes mintlify --version)", - "Bash(git commit:*)" - ] - } -} diff --git a/.gitignore b/.gitignore index 61ee0625..d818106a 100644 --- a/.gitignore +++ b/.gitignore @@ -36,3 +36,6 @@ Thumbs.db # Logs *.log logs/ + +# Local tool settings (per-machine, never committed) +.claude/settings.local.json diff --git a/.mintignore b/.mintignore index 9922f06d..4a94405d 100644 --- a/.mintignore +++ b/.mintignore @@ -5,3 +5,8 @@ # Draft content drafts/ *.draft.mdx + +# Repository documents, not site pages +/SECURITY.md +/ACCESSIBILITY.md +/THIRD_PARTY_NOTICES.md diff --git a/ACCESSIBILITY.md b/ACCESSIBILITY.md new file mode 100644 index 00000000..ac0d88f6 --- /dev/null +++ b/ACCESSIBILITY.md @@ -0,0 +1,26 @@ +# Accessibility + +This statement covers the ResQ documentation site at [docs.resq.software](https://docs.resq.software), which is built from this repository. + +## Target + +We aim for the site to meet the [Web Content Accessibility Guidelines (WCAG) 2.2](https://www.w3.org/TR/WCAG22/) at level AA. + +## Status + +The site has **not yet been formally audited** against WCAG 2.2 AA, and this repository does not yet run automated accessibility checks. Until it has been audited, we can't say how far the site meets the target. + +The site runs on Mintlify, which provides the page layout, navigation and search. This repository controls the content, the theme colors in `docs.json`, the styles in `custom.css`, and the images and diagrams. + +## Known issues + +None recorded yet. Because the site hasn't been audited, there are probably barriers we haven't found, and we want to hear about them. + +## Reporting a barrier + +If part of the site is hard or impossible to use with your setup, tell us: + +- open an issue at [github.com/resq-software/docs/issues](https://github.com/resq-software/docs/issues/new), or +- email `contact@resq.software` if you'd rather not use GitHub. + +Please include the page address, what you were trying to do, and the browser and any assistive technology you were using. diff --git a/LICENSE b/LICENSE index 54113742..261eeb9e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,201 @@ -MIT License - -Copyright (c) 2023 Mintlify - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index feacc787..497e5923 100644 --- a/README.md +++ b/README.md @@ -272,3 +272,5 @@ See [`AGENTS.md`](AGENTS.md) for project-specific instructions when collaboratin ## License Copyright 2026 ResQ. Licensed under the [Apache License, Version 2.0](LICENSE). + +The site was created from the Mintlify starter template, whose MIT license is kept in [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..80ce2006 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,39 @@ +# Security Policy + +This repository follows the [ResQ organization security policy](https://github.com/resq-software/.github/blob/main/SECURITY.md), which sets out supported versions, response times and scope for every `resq-software` repository. + +## Reporting a vulnerability + +**Do not open a public issue for a suspected vulnerability.** Report it through one of these private channels: + +1. **GitHub private vulnerability reporting** (preferred): use "Report a vulnerability" on this repository's [Security tab](https://github.com/resq-software/docs/security). +2. **Email**: `security@resq.software`. + +Include the affected page or file, the commit SHA if you have it, a short description of the issue and its impact, and steps to reproduce. + +## EU Cyber Resilience Act reporting + +Where the EU Cyber Resilience Act (Regulation (EU) 2024/2847) applies to a product in this repository, ResQ reports through ENISA's Single Reporting Platform, to the CSIRT designated as coordinator and to ENISA: + +- **Actively exploited vulnerabilities:** an early warning within 24 hours of becoming aware of one, a notification within 72 hours, and a final report no later than 14 days after a corrective or mitigating measure is available. +- **Severe incidents** affecting the security of the product: an early warning within 24 hours, a notification within 72 hours, and a final report within one month of the notification. + +We inform affected users as the Act requires. Reporting to us through the private channels above never requires you to contact ENISA yourself. You may also report to a national CSIRT under its coordinated vulnerability disclosure policy. + +## Safe harbour + +If you make a good-faith effort to follow this policy while researching a vulnerability, we will: + +- treat your research as authorised, and not pursue or support legal action against you for it; +- work with you to understand and fix the issue quickly; and +- credit you, unless you ask us not to. + +Good faith means that you: + +- test only against your own accounts, data and installations; +- stop and report as soon as you find a vulnerability; +- access, change or keep no one else's data beyond what's needed to show the issue; +- don't degrade our services or anyone else's; and +- give us reasonable time to fix the issue before you disclose it. + +This safe harbour covers ResQ's own claims only; it cannot bind third parties. diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md new file mode 100644 index 00000000..20bb98fb --- /dev/null +++ b/THIRD_PARTY_NOTICES.md @@ -0,0 +1,29 @@ +# Third-party notices + +This repository was created from the [Mintlify starter template](https://github.com/mintlify/starter) (`mintlify/starter`). Any portions of that template that remain in this repository are used under the MIT License below, as published with the template. Everything else in this repository is licensed under the Apache License, Version 2.0; see `LICENSE`. + +## Mintlify starter template + +```text +MIT License + +Copyright (c) 2023 Mintlify + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +``` diff --git a/ar/index.mdx b/ar/index.mdx index c775dd39..bcbb59a2 100644 --- a/ar/index.mdx +++ b/ar/index.mdx @@ -100,10 +100,9 @@ Apache-2.0. سلسلة أدلة مشفرة على IPFS و Solana — كل إجراء قابل للتدقيق، وكل تسليم قابل للإثبات. - - موافقة المهام بإنسان في الحلقة (HITL، المادة 14 من قانون - الذكاء الاصطناعي للاتحاد الأوروبي) وضوابط المجال الجوي - المسموح به مدمجة في تدفق الإرسال. + + تنتظر المهام الحرجة موافقة مشغّل يملك نطاق `missions.approve`، + ويرفض نظام الإرسال خطط الطيران خارج المجال الجوي المسموح به. حقن الأخطاء، التنبيهات التنبؤية، وقياس عن بُعد مرن شبكيًا diff --git a/docs.json b/docs.json index bfb0d855..55b69788 100644 --- a/docs.json +++ b/docs.json @@ -9634,6 +9634,17 @@ "github": "https://github.com/resq-software", "linkedin": "https://linkedin.com/company/resq-systems-inc", "website": "https://resq.software" - } + }, + "links": [ + { + "header": "Policies", + "items": [ + { + "label": "Accessibility", + "href": "https://github.com/resq-software/docs/blob/main/ACCESSIBILITY.md" + } + ] + } + ] } } \ No newline at end of file diff --git a/es/index.mdx b/es/index.mdx index 4b0b1bf8..a1ffa485 100644 --- a/es/index.mdx +++ b/es/index.mdx @@ -113,9 +113,10 @@ Todo de código abierto bajo Apache-2.0. Cadena criptográfica de evidencia sobre IPFS y Solana — cada acción auditable, cada transferencia demostrable. - - Aprobación de misiones con humano en el bucle (HITL, Art. 14 de la Ley - de IA de la UE) y control de espacio aéreo permitido integrados en el flujo. + + Las misiones críticas esperan a un operador con el alcance + `missions.approve`, y el despachador rechaza los planes de vuelo fuera + del espacio aéreo permitido. Inyección de fallos, alertas predictivas y telemetría resiliente diff --git a/hi/index.mdx b/hi/index.mdx index cef51304..9dcd9ce0 100644 --- a/hi/index.mdx +++ b/hi/index.mdx @@ -100,9 +100,10 @@ mode: "wide" IPFS और Solana पर क्रिप्टोग्राफ़िक साक्ष्य श्रृंखला — हर क्रिया ऑडिट योग्य, हर हैंड-ऑफ़ प्रमाणित। - - मानव-इन-द-लूप मिशन अनुमोदन (EU AI Act Art. 14 HITL) और अनुमत - एयरस्पेस गेटिंग डिस्पैच फ़्लो में निर्मित। + + महत्वपूर्ण मिशन `missions.approve` स्कोप वाले ऑपरेटर के अनुमोदन की + प्रतीक्षा करते हैं, और डिस्पैचर अनुमत एयरस्पेस से बाहर की उड़ान + योजनाओं को अस्वीकार करता है। फ़ॉल्ट इंजेक्शन, भविष्यसूचक अलर्ट्स और मेश-लचीली टेलीमेट्री diff --git a/index.mdx b/index.mdx index b169c8e4..1d5e6877 100644 --- a/index.mdx +++ b/index.mdx @@ -148,9 +148,9 @@ you need. All open source under Apache-2.0. Cryptographic evidence chain over IPFS and Solana — every action auditable, every hand-off provable. - - Human-in-the-loop mission approval (EU AI Act Art. 14 HITL) and - permitted-airspace gating built into the dispatch flow. + + Critical missions wait for an operator with the `missions.approve` + scope, and the dispatcher refuses flight plans outside permitted airspace. Fault injection, predictive alerts, and mesh-resilient telemetry diff --git a/scripts/i18n_parity.py b/scripts/i18n_parity.py index e3b37206..087cc654 100644 --- a/scripts/i18n_parity.py +++ b/scripts/i18n_parity.py @@ -25,7 +25,14 @@ EXEMPT_FILE = ".i18n-exempt" -EXCLUDED_NAMES = {"README.md", "AGENTS.md", "CONTRIBUTING.md"} +EXCLUDED_NAMES = { + "README.md", + "AGENTS.md", + "CONTRIBUTING.md", + "SECURITY.md", + "ACCESSIBILITY.md", + "THIRD_PARTY_NOTICES.md", +} EXCLUDED_DIRS = (".github", "node_modules", "snippets", "sdks", "automation") # Components whose absence changes what a reader can actually do, as opposed to diff --git a/sdks/cpp/api/resq-common/resq.md b/sdks/cpp/api/resq-common/resq.md index ca965b3b..4e826711 100644 --- a/sdks/cpp/api/resq-common/resq.md +++ b/sdks/cpp/api/resq-common/resq.md @@ -36,7 +36,7 @@ http://www.apache.org/licenses/LICENSE-2.0 No-Fly Zone (NFZ) and geofencing utilities -Provides geofencing functionality for FAA Part 107 compliance: +Provides geofencing primitives for checking positions and flight paths against no-fly zones: * No-fly zone polygon definitions diff --git a/zh/index.mdx b/zh/index.mdx index d4cbd950..06a292c2 100644 --- a/zh/index.mdx +++ b/zh/index.mdx @@ -96,9 +96,9 @@ mode: "wide" 基于 IPFS 与 Solana 的密码学证据链 —— 每一项操作可审计,每一次交接可证明。 - - 人在回路任务审批(欧盟人工智能法案第 14 条 HITL) - 及许可空域准入,均内置于调度流程之中。 + + 关键任务须等待具备 `missions.approve` 权限范围的操作员批准, + 调度器会拒绝超出许可空域的飞行计划。 故障注入、预测告警与网状容错遥测,