-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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
Approach for referencing conceptual docs #25530
Conversation
@dotnet/efteam Would appreciate quick feedback on this before I do the whole codebase. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks perfect to me - except the doc system doesn't seem to render them :(
- MS.Data.Sqlite already has some
<seealso>
links, but these unfortunately don't seem to be rendered by the doc system (compare this source with this rendered doc page). We should probably reach out to the docs team and see what's up with that. - Nit: for other doc elements we put a single padding space around the text - I've never been sure why we do that (and nobody else seems to, e.g. ASP.NET).
- I'm still not sure about the value of the extra aka.ms indirection, given that we always maintain permanent redirections when moving pages. But no strong feelings here.
Thanks @roji. Agree we should reach out to the docs team, but we'll also need to come up with something that works before then. I was thinking of just adding links in the remarks section. |
Agreed, that sounds like the next-best thing. |
bd37897
to
2ccf44b
Compare
Updated with inline links. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Part of #17508 This is a proof-of-concept on how to do this to get team review on before I do the whole codebase. For the change-tracking namespace I ended up with these links: ```C# /// <seealso href="https://aka.ms/efcore-docs-value-comparers">Documentation for EF Core value comparers.</seealso> /// <seealso href="https://aka.ms/efcore-docs-cascading">Documentation for EF Core cascade deletes and deleting orphans.</seealso> /// <seealso href="https://aka.ms/efcore-docs-change-tracking">Documentation for EF Core change tracking.</seealso> /// <seealso href="https://aka.ms/efcore-docs-entity-entries">Documentation for accessing tracked entities in EF Core.</seealso> /// <seealso href="https://aka.ms/efcore-docs-debug-views">Documentation for EF Core debug views.</seealso> /// <seealso href="https://aka.ms/efcore-docs-track-graph">Documentation for tracking entities in EF Core.</seealso> /// <seealso href="https://aka.ms/efcore-docs-providers">Documentation for EF Core database providers.</seealso> /// <seealso href="https://aka.ms/efcore-docs-local-views">Documentation for local views of tracked entities in EF Core.</seealso> ``` Also, I think it's okay to reference multiple of these where appropriate. In particular, for cross-cutting features like debug views. Aka links are not actually created yet.
2ccf44b
to
1054413
Compare
Part of #17508
This is a proof-of-concept on how to do this to get team review on before I do the whole codebase. For the change-tracking namespace I ended up with these links:
Also, I think it's okay to reference multiple of these where appropriate. In particular, for cross-cutting features like debug views.
Aka links are not actually created yet.