Efcore.pg: API documentation

[austindrenski]

It doesn't look like API documentation is generated for the EF 6/Core providers. Is it possible to generate it for hosting alongside the Npgsql API docs?

[roji]

It should be possible, but I don't think there's much value in that... The actual consumer-facing API surface of the EF providers is very small (beyond what is standard EF of course), aside from a few Npgsql extension methods (which are already documented elsewhere) I don't think it would help anyone.

Do you have anything specific in mind that you think would be helpful?

[austindrenski]

Do you have anything specific in mind that you think would be helpful?

Primarily, I'm interested in the extension documentation for consumers. I think it would make sections on operation translation more informative to be able to link to real API docs for things like type signatures, exception information, or more detailed examples.

As a secondary consideration, I think that documentation beyond the extensions would make the project more approachable to new contributors.

It took me a while to sleuth through enough project files to get an idea of how a new feature could be contributed. Online documentation would have made it easier for me. This is of course, just my opinion. But if it's cheap to generate the docs, why not?

If we were to move forward with this, I could volunteer some time toward it for the next release cycle.

[roji]

I'll try to take a look at it, if there's nothing serious blocking it we'll do it. Also no real need to couple it with the release cycle, we can update docs whenever we want.

[roji]

If this doesn't get any attention in the coming few weeks, please ping to remind me.

[roji]

This is done.