Skip to content

docs: separate API reference documentation from README customer section #5166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Zelys-DFKH wants to merge 2 commits into
base: main
Choose a base branch
from

refactor: generate API_README.md at build time via mkdocs hook

272c987
Select commit
Loading
Failed to load commit list.
Open

docs: separate API reference documentation from README customer section #5166

refactor: generate API_README.md at build time via mkdocs hook
272c987
Select commit
Loading
Failed to load commit list.
SonarQubeCloud / SonarCloud Code Analysis succeeded Apr 8, 2026 in 57s

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Annotations

Check warning on line 39 in docs/generate_api_readme.py

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Remove the unused function parameter "config". 

See more on https://sonarcloud.io/project/issues?id=aws-powertools_powertools-lambda-typescript&issues=AZ1uE1Az39oYaSTaQ3SD&open=AZ1uE1Az39oYaSTaQ3SD&pullRequest=5166

Check warning on line 15 in docs/generate_api_readme.py

See this annotation in the file changed.

@sonarqubecloud sonarqubecloud / SonarCloud Code Analysis

Fix this reluctant quantifier that will only ever match 0 repetitions. 

See more on https://sonarcloud.io/project/issues?id=aws-powertools_powertools-lambda-typescript&issues=AZ1uE1Az39oYaSTaQ3SC&open=AZ1uE1Az39oYaSTaQ3SC&pullRequest=5166
View more details on SonarQubeCloud