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

Docs improvement #181

Open
6 tasks
DavidMarquezF opened this issue Feb 24, 2021 · 0 comments
Open
6 tasks

Docs improvement #181

DavidMarquezF opened this issue Feb 24, 2021 · 0 comments
Assignees
Labels
📘 documentation Improvements or additions to documentation

Comments

@DavidMarquezF
Copy link

DavidMarquezF commented Feb 24, 2021

Right now I feel like the docs are lacking a bit. I know this is constant development but I wanted to know if there was any plan in improving mostly the following aspects:

  • Getting started guide: 2 - onboard, 3 - interact
  • dashboard: example auth_config.json doesn't work (not sure if it should, but gives unknown client error). An explanation on how to set up the auth_config or a description of what each parameter means
  • A full example, start to finish on how to set up and use the whole system (maybe even with a device set up from the getting started guide from iotivty, this way it would be a fitting follow-up)
  • How plgd compares to other platforms
  • Document reference architectures
  • Fix C4 diagram and dependencies between GWs and EB

I understand documentation might not be high priority right now but I thought I would create the issue either way.

@ondrejtomcik ondrejtomcik self-assigned this Aug 4, 2021
@ondrejtomcik ondrejtomcik added the 📘 documentation Improvements or additions to documentation label Aug 4, 2021
@ondrejtomcik ondrejtomcik added this to the 2.0.0 milestone Aug 10, 2021
@ondrejtomcik ondrejtomcik removed this from the 2.0.0 milestone Jan 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📘 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants