Documentation still requires an NDA

Question

Documentation still requires an NDA

leeter opened this issue 3 years ago · 5 comments

leeter commented 3 years ago

So while this is public and we can see the samples... the documentation still requires an NDA

https://docs.microsoft.com/en-us/gaming/gdk/_content/gc/reference/system/dstorage/dstorage_members

Can we get a public version of this put under the proper DirectX category on docs.microsoft.com as this is now public?

Answer 1 · 2022-03-16T21:56:20.000Z

Please see https://github.com/microsoft/DirectStorage/blob/main/Docs/DeveloperGuidance.md

Answer 2 · 2022-03-16T22:16:28.000Z

Unfortunately the linked documentation does not adequately cover the API itself only high level usage. That documentation is still locked behind an NDA. So right now Developers do not have access to how to properly use the API other than the samples.

Answer 3 · 2022-03-16T22:20:20.000Z

Specifically the contents of https://docs.microsoft.com/en-us/gaming/gdk/_content/gc/reference/system/dstorage/dstorage_members MUST be made public to properly use the API without abuse.

Answer 4 · 2022-03-16T22:21:15.000Z

Currently, please see dstorage.h for reference documentation for the Windows version of DirectStorage.

Answer 5 · 2022-03-16T22:23:11.000Z

A header file is not documentation. It does not document expected return values or intricacies of use. I'll just recommend against use until this is properly documented.