Skip to content

Missing Documentation for many subsystems and features #12955

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

Jump to bottom
Closed
5 tasks done
nashif opened this issue Feb 1, 2019 · 5 comments
Closed
5 tasks done

Missing Documentation for many subsystems and features #12955

nashif opened this issue Feb 1, 2019 · 5 comments
Assignees
@jhedberg @jukkar @mike-scott
Labels
area: Bluetooth area: Documentation area: File System area: LWM2M area: Networking bug The issue is a bug, or the PR is fixing a bug priority: medium Medium impact/importance bug
Milestone
v1.14.0

Comments

@nashif
Copy link
Member

nashif commented Feb 1, 2019 •
edited
Loading

We are missing tons of documentation for various components and subsystems

more to follow...
@nashif nashif added the bug The issue is a bug, or the PR is fixing a bug label Feb 1, 2019
@pfalcon
Copy link
Collaborator

pfalcon commented Feb 4, 2019

cc @rlubos, @mike-scott

Would be nice to get more details on what exactly "We are missing tons of documentation for various components and subsystems" means. For MQTT, API reference is definitely there, not sure about a "guide" docs section.

@galak galak added the priority: high High impact/importance bug label Feb 8, 2019
@galak galak added this to the v1.14.0 milestone Feb 8, 2019
This was referenced Feb 13, 2019
Closed
Closed
@erwango
Copy link
Member

erwango commented Feb 20, 2019

Adding fs

@dcpleung
Copy link
Member

@nashif Since we have individual bugs opened already, should we close this one?

@nashif nashif removed bug The issue is a bug, or the PR is fixing a bug priority: high High impact/importance bug labels Mar 2, 2019
@nashif nashif removed their assignment Mar 2, 2019
@mike-scott
Copy link
Contributor

@galak I'm working on the "overview" portion of LwM2M documentation and expect it to be ready in 1-2 days.

NOTE: High-level API documentation was merged here: b56035c

@rljordan-zz rljordan-zz added the priority: medium Medium impact/importance bug label Mar 6, 2019
@nashif
Copy link
Member Author

nashif commented Mar 29, 2019

closing this catchall issue

@nashif nashif closed this as completed Mar 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jhedberg jhedberg

@jukkar jukkar

@mike-scott mike-scott

Labels
area: Bluetooth area: Documentation area: File System area: LWM2M area: Networking bug The issue is a bug, or the PR is fixing a bug priority: medium Medium impact/importance bug
Projects
None yet
Milestone
v1.14.0
Development

No branches or pull requests
9 participants
@nashif @pfalcon @jhedberg @jukkar @mike-scott @rljordan-zz @galak @erwango @dcpleung