Skip to content

docs: refresh the README and the feature table - #8733

Merged
leandrodamascena merged 1 commit into
developfrom
docs/readme-refresh
Nov 1, 2026
Merged

leandrodamascena merged 1 commit into
developfrom
docs/readme-refresh

Conversation

@leandrodamascena

Copy link
Copy Markdown
Contributor

Issue number: closes #8732

Summary

Changes

  • README rewritten at the same length: short opening that says what the toolkit does, installation with pip, uv and the Lambda layer, the feature list aligned with the docs navigation and grouped as Core, Utilities and Lambda features (adds Circuit Breaker, Auth alpha with JWT and OAuth2, Metadata, OpenAPI, Managed Instances, Durable Functions, build recipes), examples trimmed to what is alive plus the workshop and the examples folder, links to the changelog, SECURITY.md and the ADRs.
  • Fixed the broken documentation link ([� Doccumentation]), the Build badge that pointed to a workflow that no longer exists, and removed the SAR mention.
  • docs/index.md: added Circuit Breaker and Metadata to the feature table.

User experience

Someone landing on the repository today sees a 2022 feature list with a broken link in the header. After this they see the current utilities, how to install with the layer, and where the contribution rules live.

Verification

Every docs.powertools.aws.dev link in the new README returns 200. markdownlint passes on both files and zensical build passes. Written with an AI assistant; I checked each utility against the docs navigation myself.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@leandrodamascena leandrodamascena added this to the 3.40.0 milestone Nov 1, 2026
@leandrodamascena leandrodamascena added the documentation Improvements or additions to documentation label Nov 1, 2026
@leandrodamascena
leandrodamascena requested a review from a team as a code owner November 1, 2026 10:11
@powertools-for-aws-oss-automation powertools-for-aws-oss-automation Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 1, 2026
@sonarqubecloud

sonarqubecloud Bot commented Nov 1, 2026

Copy link
Copy Markdown

@leandrodamascena
leandrodamascena merged commit bc3136c into develop Nov 1, 2026
10 checks passed
@leandrodamascena
leandrodamascena deleted the docs/readme-refresh branch November 1, 2026 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: README is out of date with the project

1 participant