Repository navigation
docs: audit the public docs and prepare the 3.0.0 changelog - #71
Merged
Merged
Conversation
Blind-Striker
added this pull request to stack #69
October 23, 2026 13:33
This was referenced Oct 23, 2026
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Blind-Striker
force-pushed
the
aot/public-docs-3.0.0
branch
from
October 23, 2026 15:22
376b70e to
91ffc94
Compare
Rewrite the README (and its two package copies) for 3.0.0: package choice, supported frameworks with Native AOT, a short LocalStack auth-token note with links to the official docs, a minimal-hosting quick start, the configuration defaults, the registration APIs, standalone usage, the Native AOT boundary, upgrade notes and the support policy. Remove the stale announcement banner, version-strategy block, badge rows, wiki links and dead links. Start the [Unreleased] changelog section, planned as 3.0.0 for both packages. Mark the 1.x (AWS SDK v3) line unmaintained and 2.x superseded in the security policy, contribution guide and issue templates.
The README, security policy, contribution guide and templates now say that 3.x is supported and earlier versions are not, instead of describing the 2.x and 1.x lines. Upgrade details stay in the changelog.
Blind-Striker
force-pushed
the
aot/public-docs-3.0.0
branch
from
October 23, 2026 20:24
91ffc94 to
690c59d
Compare
This was referenced Oct 23, 2026
Blind-Striker
marked this pull request as ready for review
October 23, 2026 21:55
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stack (review bottom-up, merge as one stack): #62 base, #66 the #63 fix, #67 Native AOT test lane, #68 static-factory generic path, #70 slim generator, #71 public docs, #72 internal docs and 3.0.0, #73 reflection-free test, #74 package consumer in CI, #75 convention clean-up, #76 service catalog refresh.
Goal of the stack: 3.0.0, where existing consumers upgrade without code changes, both packages support Native AOT on net10.0/net11.0, and the libraries use no runtime reflection for types the compiler can see (a JIT-only fallback covers the rest).
This PR
Public-doc audit and release prep:
CHANGELOG.mdgets an[Unreleased]section planned as 3.0.0 for both packages.Maintainer rulings applied: 3.0.0 for both packages; only 3.x is supported; ship before .NET 11 GA with
net11.0marked preview; the GitHub wiki is disabled (the README and contribution guide cover its content).