docs: separate API reference documentation from README customer section

[Zelys-DFKH]

Summary

The API reference currently includes a 'Becoming a reference customer' section with company logos. Created separate API_README.md files for each package without that section. TypeDoc now references API_README.md for API docs, while the original README.md (sent to npm) retains customer references. This keeps npm users seeing the customer logos while cleaning up API documentation.

Changes

Created 12 API_README.md files and updated 12 typedoc.json configs to point to them.

Fixes #4594

---

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

[sonarqubecloud]

Quality Gate passed

Issues
0 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

[dreamorosi]

Thanks for the PR - while this does resolve the issue, I am not sure I am in favor of duplicating the contents of each README in two files.

Doing this will introduce overhead to keep them updated which will most likely result in drift.

I don't have a good solution yet - which is also why the original issue was left unresolved - but this is where I stand now.

[Zelys-DFKH]

Thanks for the feedback—you're right about the maintenance burden. I want to propose something simpler.

Instead of keeping two files in sync, we could generate the API_README.md at build time. The script strips out the customer section from README.md and writes the cleaned version to a dist directory. TypeDoc references the generated file, not a committed one. This way there's only one source file to edit, filtering is automated, and zero risk of drift.

Here's the approach: add a script like scripts/generate-api-readme.sh that runs before the TypeDoc build. It removes the "How to support Powertools" section from each README and outputs API_README.md. Update each typedoc.json to point to the generated file instead of the source. The generated files don't get committed to git.

The result is clean API docs while npm packages keep the original README with customer logos intact. Does this direction work for the project? I can implement it if you want to go this route.