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

(First) Revise the Readme #13

Open
3 tasks
BraINstinct0 opened this issue Sep 2, 2021 · 0 comments
Open
3 tasks

(First) Revise the Readme #13

BraINstinct0 opened this issue Sep 2, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@BraINstinct0
Copy link

Yes, considering that this has been released just a few days ago I won't expect the documentation to be fully written at this point.
However, it seemed to me that if users were given the choice to write down what they'll need, a 'good' readme would be easier to write.
Leaving a few notes here as a starter:

  • a short and concise Installation of tabnine-jupyterlab (and which is visible at first sight!)
  • a warning related to the project still in alpha/beta status
  • too much promotional (note: I agree that tabnine is good, but it's just too much for a Readme :)) parts should be reduced. Linking to the website seems enough.
@bilucodota bilucodota added the documentation Improvements or additions to documentation label Sep 6, 2021
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