Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upFurther improvements of documentation #67
Comments
All my comments were collapsed (I don't understand why I did wrong :( ); I'll try to list them here. |
Added a line to description on ENV VARs. Update: #120 was created right after |
updated issue desc with updates on |
About this item:
I believe the current readme has a very good introduction. Does anyone have a specific suggestion on how to improve it, or can we mark it as done? |
original comment got collapse. So here it is:
But for me README is clear in current state. |
@carlosms to speed up the review and help understanding the scope that has been addressed - could you please update the checklist in PR description? |
@bzz |
Guys do you think we still need to document |
I don't think so, it should be moved to other part of our docs (imo same reason as the one for import tool: this project is not focused in import/export databases, but in offering a web interface to annotate code and review code annotations) |
I think it's worth to have import/export CLI documented but not in README. As @smacker and @dpordomingo are right: we already have download for export and going to have upload for import soon, under new experiment management. |
Could anybody give me a reason why do we need CLI for import/export? |
@bzz: I'd rather merge #177 as it is, and do this in a future PR. If we move the CLI import and export to CONTRIBUTING, then we will want to have a screenshot or description of how to do it from the UI in the README, and the import part is not yet ready. Let me know if you agree or if I should move import & export in #177 now. |
@smacker In my option, it's just because
|
From @dpordomingo and @mcuadros comments:
#36 (comment)→ #120#170 (comment)→ #173or any other not-collapsed comments in the PR #29