Maintenance: Meta-Documentation

[neilramsay]

Why is this needed?

Recently I received great documentation guidance on a PR (#2129).

I greatly valued the guidance, and believe that others could benefit with a distilled/improved version of it.

Which area does this relate to?

Other

Solution

Create a CONTRIBUTING-DOCUMENTATION.md guide, linked from CONTRIBUTING.md.

I would like continue the discussion from PR #2129 to provide the "what, how, and why" for providing documentation.

Acknowledgment

• This request meets Lambda Powertools Tenets
• Should this be considered in other Lambda Powertools languages? i.e. TypeScript

[leandrodamascena]

Hi @neilramsay! Thank you for submitting this issue. In fact this text by @heitorlessa is an excellent guide on how we try to guide the project.

We are working on some items for this release and I have added this issue to our backlog. We'll start working on it as soon as possible.

[heitorlessa]

Starting planning this now, hopefully we can get it done by end of the year :)

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.