Repository navigation
chore(compliance): relicense to Apache-2.0, add security and accessibility statements - #139
Conversation
…sibility 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.
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (16)
💤 Files with no reviewable changes (1)
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe repository adds accessibility and security policies, updates licensing and policy-document handling, removes a local Claude settings file, and revises product descriptions across the homepage translations and C++ SDK documentation. ChangesRepository policies and licensing
Product description updates
Local settings cleanup
Priority: ➖ Normal Estimated code review effort: 2 (Simple) | ~12 minutes Change: Other Merge Risk: ⚪ Minimal · up to The changes update licensing, policy documents, and product descriptions without evidence of a broken workflow or contradictory claim. The PR appears ready to merge after normal checks. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Remediates the compliance-lens findings for this repository.
PUB-LIC-01 — root licence (2 findings)
What changed:
LICENSEis now the Apache License 2.0, byte-identical to the licence file in the org's other Apache-2.0 repositories. The copyright line stays in the README ("Copyright 2026 ResQ"), as it does in those repositories.THIRD_PARTY_NOTICES.md. It names the template it covers:mintlify/starter, which this repository was created from.README.mdkeeps its Apache-2.0 badge and licence line, and now points to the notices file.The README badge, the licence line, the
SPDX-License-Identifier: Apache-2.0headers (workflows,.spectral.yml, templates) and theinfo.licenseinspecs/*.jsonalready said Apache-2.0. OnlyLICENSEdisagreed, and now it doesn't.docs.jsonandmanifest.webmanifestdeclare no licence.PUB-SEC-01 — security policy (2 findings)
What changed: the repo had no policy of its own, so there's now a root
SECURITY.md. It links the org policy and gives the private reporting channels (private vulnerability reporting on this repo, orsecurity@resq.software). After those come the EU Cyber Resilience Act reporting and Safe harbour sections, pasted verbatim from the shared wording.PUB-ACC-01 — accessibility (2 findings)
What changed: new
ACCESSIBILITY.md, covering:contact@resq.software(the site's published contact).It's linked from the site footer ("Policies → Accessibility") so visitors to docs.resq.software can find it.
Left: automated accessibility testing. This repo has no browser-test setup (no Playwright, Cypress or similar), so no axe-core check was added. That's a follow-up.
PUB-CLM-01 — claims (2 findings)
index.mdx(home page card)missions.approvescope, and the dispatcher refuses flight plans outside permitted airspace."sdks/cpp/api/resq-common/resq.mdThe new card text is backed by facts in
concepts.mdxand the Coordination API spec: themissions.approvescope, the pending/approve/reject endpoints, and the dispatcher's airspace gate.The same card appears in the four locale mirrors (
es/,zh/,ar/,hi/index.mdx), which the README says are kept in lock-step with the English page. Their titles and text were updated to match. The locale parity check still reports 0 gaps.Left:
sdks/cpp/api/resq-common/resq.mdis generated from the C++ SDK's header. The next auto-doc PR will bring back whatever the header says, so the header needs the same softening upstream.PUB-CNF-02 — tracked local tool file (1 finding)
What changed:
.claude/settings.local.jsonis untracked (git rm --cached) and added to.gitignore. It was checked for secrets first and has none: it holds only three local permission-allow entries.Supporting changes
.mintignorekeeps the three new root documents (SECURITY.md,ACCESSIBILITY.md,THIRD_PARTY_NOTICES.md) from becoming stray site pages.scripts/i18n_parity.pyadds the same three names toEXCLUDED_NAMES, next toREADME.md,AGENTS.mdandCONTRIBUTING.md. Without this, the parity report would count them as 12 untranslated pages.Checks run locally
mint broken-links: no broken links found.python3 scripts/i18n_parity.py --root .: 0 gaps across 4 locales.mint validate: 348 warnings on this branch, the same 348 as onmain. They're all nav entries for SDK pages that don't exist, not in CI, and none relate to this change.sdks/**are deleted.Summary by CodeRabbit