[RFC]: improve README examples in namespace packages

[kgryte]

Description

This RFC proposes improving README examples in namespace packages. Currently, namespace package READMEs only include minimal examples which are not particularly informative and do not showcase namespace functionality. For example, see @stdlib/array.

Historically, namespace examples were not given much effort due to the rapidly changing nature of the project; however, now that development and organization has settled, it would be good to revisit these packages and add proper examples to better communicate to users how to use namespace contents.

For those wanting to contribute to this issue, you can use the following steps:

• Browse through the stdlib codebase and identify namespaces having only minimal README examples (e.g., start from the root directory: https://github.com/stdlib-js/stdlib/tree/64931c5fdb4abc3a339b619658d3b5acc089e556/lib/node_modules/%40stdlib)
• Leave a message on this issue letting project maintainers know that you are planning on updating a particular namespace README.
• After identifying a namespace README needing updates, update the README for that namespace and that namespace only and open a PR.
• When updating the README, examples should follow existing project conventions (e.g., ES5).
• Examples may require functionality from other packages to help make examples more interesting.

Related Issues

None.

Questions

No.

Other

No.

Checklist

• I have read and understood the Code of Conduct.
• Searched for existing issues and pull requests.
• The issue name begins with RFC:.

[vr-varad]

#1338 (comment) changed the namespace example.

[vr-varad]

#1349 added new examples

[kgryte]

@vr-varad I replied on #1349. If you are going to update namespace examples, please read the OP above. We are not seeking changes to the main project README. We are seeking improvements to namespace package READMEs.

[Tufailahmed-Bargir]

i am interested in doing this , please assign this to me

[kgryte]

@Tufailahmed-Bargir We've since added individual issues for both documentation and code contributions. I suggest searching for another individual issue to pursue.