Skip to content

docs: establish public canon and end v1 support - #55

Merged
Blind-Striker merged 1 commit into
masterfrom
docs/public-canon-v1-eol
Oct 17, 2026
Merged

Blind-Striker merged 1 commit into
masterfrom
docs/public-canon-v1-eol

Conversation

@Blind-Striker

Copy link
Copy Markdown
Member

📝 Description

Establish a public, self-contained documentation canon for LocalStack.NET. Add a thin AGENTS.md, a domain-only GLOSSARY.md, source-backed architecture and engineering guidance, and three historical ADRs selected with the exact eligibility test from opencode-sdk-dotnet.

Correct consumer and contributor guidance for SDK v4/AOT boundaries, published Core 2.0.0 and Extensions 2.0.1 versions, test/build side effects, and LocalStack service mapping versus emulator capability. End the v1.x / AWS SDK v3 support window in SECURITY.md and relay it in README and GitHub templates. Previously published v1 packages and the sdkv3-lts branch remain available, but no further v1 fixes are promised. Remove the stale Copilot instructions in favor of the current AGENTS.md.

Related issues: No issue is closed by this documentation change. The AWS SDK v4 migration, constructor regression, and legacy-port decision are historical context, not newly implemented features.

🔄 Type of Change

  • 📚 Documentation update
  • 🐛 Bug fix
  • 💥 Breaking change

🎯 Target Version Track

  • v2.x (AWS SDK v4) — current master and public documentation

🧪 Testing

  • Manual documentation review, independent two-axis review and review-fix assertions
  • Local Markdown relative links, three package-README hashes, exact ADR eligibility text, v1 support-policy assertions, fence closure, new-document whitespace, and git diff --check
  • .NET build/tests — not run: content and templates only; the Cake functional path enumerates all Docker containers and is unsafe on a shared daemon. The main CI workflow ignores Markdown-only changes, although dependency review may still run on a PR.

Environment: Windows, PowerShell 7 for local documentation checks. No LocalStack container or AWS service call was started.

📚 Documentation

  • Root and both packaged README copies identical
  • Current architecture, glossary, agent routing, accepted rationale, contributor and security guidance aligned
  • No Native AOT delivery, NuGet publish-run outcome, current badge status, or historical LocalStack image operation support claimed without evidence

✅ Code Quality Checklist

  • No production code changed
  • No test was weakened or disabled
  • artifacts/ and the proposed organization-wide internal archive remain outside this PR

🔍 Reviewer Focus Areas

  • Does the v1 end-of-support message distinguish LocalStack.NET's July 2026 policy from AWS SDK v3's June 1, 2026 end-of-support?
  • Does the public canon stand alone without private historical files?
  • Are ADRs limited to historically accepted, evidenced trade-offs rather than proposals such as draft AOT PR Native AOT Support via Source Generator + UnsafeAccessor Architecture #49?
  • Does README preserve the dual GitHub/NuGet package-reader context with working public links?

Breaking changes: No package or runtime change. The support policy now explicitly ends v1 maintenance; existing v1 artifacts remain available.

Dependencies: No package changes.

@github-actions

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@Blind-Striker
Blind-Striker merged commit c1343aa into master Oct 17, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant