Skip to content
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.

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

Improve the OS/Platform abstraction layer documentation #20

Open
silabs-ThibautC opened this issue Jun 10, 2024 · 1 comment
Open

Improve the OS/Platform abstraction layer documentation #20

silabs-ThibautC opened this issue Jun 10, 2024 · 1 comment

Comments

@silabs-ThibautC
Copy link
Collaborator

It has come to our attention that the documentation lacks the necessary precision and depth that developers require for autonomous integration and implementation. Reverse engineer what we did should be the fallback, not the default.
I propose an enrichment of the documentation to include the following:

  • detailed descriptions of each function. They should be accompanied by a comprehensive description, outlining not only its purpose but also any subtleties in its behavior or usage. Referring to Posix or assuming the developers are familiar with Posix won't be enough and could slow down the adoption. The best example is select() implementation which only needs to support sockets. It needs to be very explicit about the block or non-blocking nature of each API.
  • detail description of each constant, including error codes and priorities.
  • a contribution guide and/or a developer starting guide could also be helpful. It could detail where to create what and summarize the discussions we had about the osal/ directory organization.
@paduffy
Copy link
Collaborator

paduffy commented Jun 10, 2024

I will add to this more thorough documentation of the object model/.proto file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants