oauthenticator icon indicating copy to clipboard operation
oauthenticator copied to clipboard

Configuration reference cluttered by having Local and normal class on the same page

Open consideRatio opened this issue 2 years ago • 1 comments

In our configuration reference, we end up with pages with two classes documented (GitHubOAuthenticator, but also LocalGitHubOAuthenticator), and skimming through it is overall a bit confusing due to it.

I'd like to avoid having documentation that puts both classes in the same page, making an in-page search find two different results for example. I'm not sure how, so I'm just describing this as an issue for now.

The issue can be seen here, and here is a gif about it as well.

oauth-duplicated-for-local

consideRatio avatar Jun 30 '23 11:06 consideRatio

I think you should be able to toggle-off inherited members, so it should only document what's new in the class. Or opt-in to specific members.

minrk avatar Jun 30 '23 18:06 minrk