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

Generate API docs grouped by .NET Platform Standard version from packages #15631

Closed
davidfowl opened this issue Nov 5, 2015 · 8 comments
Closed
Assignees
Labels
area-Meta documentation Documentation bug or enhancement, does not impact product or test code
Milestone

Comments

@davidfowl
Copy link
Member

The same way we generated this list:

https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/standard-platform.md#list-of-net-corefx-apis-and-their-associated-net-standard-platform-version-tentative

It would be cool if we could generate an MSDN style API doc experience for the .NET Standard Platform versions.

/cc @ericstj @richlander @Petermarcu

@davidfowl davidfowl changed the title Generate API docs grouped by .NET Standard Platform from packages Generate API docs grouped by .NET Platform Standard from packages Nov 6, 2015
@davidfowl davidfowl changed the title Generate API docs grouped by .NET Platform Standard from packages Generate API docs grouped by .NET Platform Standard version from packages Nov 6, 2015
@davidfowl
Copy link
Member Author

Some ideas for visualizations - http://caniuse.com/

@khellang
Copy link
Member

khellang commented Nov 9, 2015

@davidfowl Do you have the data for the generated list available anywhere? It would be cool if we as a community could try to come up with different ways of visualizing it. Play around with d3.js or something 😄

@davidfowl
Copy link
Member Author

@davidfowl Do you have the data for the generated list available anywhere? It would be cool if we as a community could try to come up with different ways of visualizing it. Play around with d3.js or something 😄

The packages are the data. We could go further and index on a per API basis like packagesearch does.

/cc @glennc

@ericstj
Copy link
Member

ericstj commented Mar 25, 2016

I have the entire table encoded in the package source I just need to emit it in a friendly fashion. I was thinking to do two things: emit to the package description as well as a separate data file. Separate data file could be used to generate table in docs.

@blackdwarf
Copy link

@ericstj that would be really cool. +100000 to doing it.

@ericstj
Copy link
Member

ericstj commented Mar 26, 2016

I'll make the packages emit a data file with supported platforms and pointers to the assemblies for that platform. As a start I'll used this to generate the table. I don't think I can tackle generating the API docs yet, but there will be a good structured input file for doing this.

@blackdwarf
Copy link

@ericstj is this something we could use docfx for? The API generation I mean?

@khellang
Copy link
Member

This happened?

@msftgits msftgits transferred this issue from dotnet/corefx Jan 31, 2020
@msftgits msftgits added this to the 2.0.0 milestone Jan 31, 2020
@ghost ghost locked as resolved and limited conversation to collaborators Jan 4, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-Meta documentation Documentation bug or enhancement, does not impact product or test code
Projects
None yet
Development

No branches or pull requests

5 participants