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

Need API docs for dynamic dependencies #1003

Closed
asklar opened this issue Jun 30, 2021 · 5 comments
Closed

Need API docs for dynamic dependencies #1003

asklar opened this issue Jun 30, 2021 · 5 comments
Assignees
Labels
area-DynamicDependencies documentation Improvements or additions to documentation
Milestone

Comments

@asklar
Copy link
Member

asklar commented Jun 30, 2021

Searching online for mddBootstrapInitialize doesn't turn up any good hits. Ideally we should have api docs on docs.microsoft.com but something on here would work. There is a dynamic dependencies spec that mentions the architecture/design of DD, but not an API reference page.

@DrusTheAxe DrusTheAxe added area-DynamicDependencies documentation Improvements or additions to documentation labels Jul 1, 2021
@DrusTheAxe DrusTheAxe added this to the 1.0 (2021 Q4) milestone Jul 1, 2021
@DrusTheAxe
Copy link
Member

DrusTheAxe commented Jul 1, 2021

You're not wrong just ahead of the curve. The feature's currently experimental and per the Channels decision under "Bars for getting a feature into each release..." we will have documentation (API Reference, etc) no later than when it enters the Preview channel:

Bar Experimental (== main) Preview Stable
Docs At least an API spec or GitHub Issue with some examples devs can work from Preview of primary docs experience published on docs site (either conceptual or API ref) Conceptual and API ref docs

The roadmap doesn't clearly say it but the "Unpackaged desktop apps" row includes Dynamic Dependencies so docs are coming. But API information should already be available if you check MddBootstrap.h or the spec the prototypes include full doc-comments.

Tutorial: Build and deploy an unpackaged app includes sample usage (step 3. "You are now ready to use the dynamic dependencies API to initialize the Bootstrapper..."). It's also used in some of the 0.8 samples, e.g. MRTCore's console_unpackaged_app.cpp. Were you aware of these? Do they help provide a working understanding to unblock you?

@asklar
Copy link
Member Author

asklar commented Jul 1, 2021

thanks Howard; I'm not currently blocked on this, just thought I'd bring it up since developers will eventually need something like it.
I actually found this API from the tutorial (and then found the spec), and I wanted to learn more about it and what other APIs are available, which I would have found through links on DMC : )

@DrusTheAxe
Copy link
Member

Agreed on the needs. Docs are in plan they just weren't ready as quickly as the code. But thanks for the feedback. It sparked some (more) discussions regarding documentation and discovery. Stay tuned!

P.S. DMC=?

@asklar
Copy link
Member Author

asklar commented Jul 2, 2021

Thanks @DrusTheAxe, good to know! Feel free to ping me internally about auto-generating docs from winmd if you are looking to do that as i've done this for react native for windows : )
DMC=docs.microsoft.com. more pronounceable :)

@DrusTheAxe
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-DynamicDependencies documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants