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

[SDK Feature-Request] SDK example docs pages #988

Closed
Erol444 opened this issue Apr 3, 2023 · 1 comment · Fixed by #1070
Closed

[SDK Feature-Request] SDK example docs pages #988

Erol444 opened this issue Apr 3, 2023 · 1 comment · Fixed by #1070
Assignees
Labels
enhancement New feature or request sdk Related to DepthAI SDK

Comments

@Erol444
Copy link
Member

Erol444 commented Apr 3, 2023

Start with the why:

A good documentation page is always critical for any API/library, this addition would nicely supplement the #956 PR. Another benefit would be that we can link some examples from docs (eg. for support), instead of linking source code.

Move to the what:

For each depthai_sdk/example add a documentation page. Add some information about the example, a demo video/image, some things to note, demos pipeline graph, its code, and link to github. So very similar to how we have Code samples docs for depthai API.

Move to the how:

Some manual work:)

@Erol444 Erol444 added enhancement New feature or request sdk Related to DepthAI SDK labels Apr 3, 2023
@jakaskerl
Copy link
Contributor

#1070

@Erol444 Erol444 linked a pull request Jul 3, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request sdk Related to DepthAI SDK
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants