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

Move example Wiki to the source tree #170

Open
kbumsik opened this issue Aug 25, 2020 · 2 comments
Open

Move example Wiki to the source tree #170

kbumsik opened this issue Aug 25, 2020 · 2 comments
Labels
Contributhon OpenSource Contributhon 2020

Comments

@kbumsik
Copy link
Contributor

kbumsik commented Aug 25, 2020

I suggest moving the example Wiki (https://github.com/nnstreamer/nnstreamer/wiki/usage-examples-screenshots) to the source tree in this repo (maybe in README.md).

To be clear, I am talking about the specific wiki page, not the Wiki as a whole. I think the other pages are in the right place.

When I was having fun with the examples, I noticed the wiki page is out of sync with the repo. For example, s/nnsuite/nnstreamer/g, the use of wget when get_model.sh is available, some undocumented examples, and etc.

Although Github Wiki is a convenient tool to quickly update notes but Github Wiki has some drawbacks. I could not submit a change even though I noticed some errors, because the wiki currently allows edits only from contributors.

Moving the example Wiki to README.md will have advantages:

  1. Allows other developers to correct errors through a PR.
  2. It is easier to keep it updated. You can ask a PR to add descriptions of new examples in README.md during the review process. I believe it is quite important.

Thanks for reading :)

@taos-ci
Copy link
Collaborator

taos-ci commented Aug 25, 2020

:octocat: cibot: Thank you for posting issue #170. The person in charge will reply soon.

@dongju-chae dongju-chae added the Contributhon OpenSource Contributhon 2020 label Aug 26, 2020
@myungjoo
Copy link
Member

myungjoo commented Sep 9, 2020

Ok. could you please add a PR that does what you suggest? Then, we may be able to remove that Wiki page and add a link from Wiki to the nnstreamer-example repo.

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

No branches or pull requests

4 participants