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

Complete docs #267

Open
nirs opened this issue Oct 31, 2017 · 0 comments
Open

Complete docs #267

nirs opened this issue Oct 31, 2017 · 0 comments

Comments

@nirs
Copy link
Member

nirs commented Oct 31, 2017

We have initial docs directory with some content duplicated from the README.md and examples/README. We need to remove the duplication, and improve the layout.

When we write the docs, we should consider the audience:

  • Teachers - may want to use this project in their classroom
  • Students - may want to write a driver module
  • Developers that may like to contribute to the project
  • Maintainers that want to cut a release
  • Other?

Looking in the github traffic report, we can see that the main README page is the most
popular page. So we want everything linked from this page.

When a user visit the docs, they may like to go back to the project in github, we want a link
from the docs back to the project.

Possible layout (role based)

  • README.md
    • simple overview of the project, no details
    • video/pictures/live demo, make it fun
    • links to most docs in github.io
  • docs/index.md - show all the available docs
  • docs/teachers.md - docs for teachers
  • docs/students.md - docs for students
  • docs/contributing.md - docs for developers
  • docs/release.md - docs for maintainers
@nirs nirs added this to the Release 1.0 milestone Nov 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants