Azure-sdk-for-js: [Cognitive Search] Create getting started documentation
This tracks the work for generating the getting started documentation for the library
AlexGhiondea
All 5 comments
Just start over on the documentation. It has been a nightmare to even try to find how to copy/rename a blob.
Really makes me want to switch to lesser known libraries with documentation that is readable. Your API reference is not.
jtsmedley
on 31 Jan 2020
Hi @jtsmedley - this is something that I'm actively working on right now. We know that legibility in the refdocs can be problematic sometimes. I would love to know more details of what your biggest pain points are in more detail. Happy to follow up in this thread or to have a call if you were interested.
maggiepint
on 31 Jan 2020
@maggiepint My main issue today is there is no reference to how to rename a blob which appears to need a copy instead, but I can't get the copy to work off the documentation.
jtsmedley
on 31 Jan 2020
@jtsmedley can you share more about the package you are using?
AlexGhiondea
on 31 Jan 2020
@jtsmedley I created #7202 to continue discussion specific to storage blob api. It's our bad that we didn't have enough information to indicate that this issue is tracking the doc work for the Cognitive Search library.
You are still welcome to continue providing more feedback either here or through new issues. Thank you!
jeremymeng
on 1 Feb 2020
Related issues
kaerm
路
4Comments
gmantri
路
3Comments
SlothFriend
路
3Comments
dgellow
路
4Comments
isaacjoe
路
4Comments
Most helpful comment
@maggiepint My main issue today is there is no reference to how to rename a blob which appears to need a copy instead, but I can't get the copy to work off the documentation.