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.

Sign up for GitHub

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

Jump to bottom

Approach for referencing conceptual docs #25530

Merged
merged 3 commits into from
Aug 20, 2021
Merged

Approach for referencing conceptual docs #25530

merged 3 commits into from
Aug 20, 2021

Commits on Aug 20, 2021

  1. Approach for referencing conceptual docs 

    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.
    @ajcvickers
    ajcvickers committed Aug 20, 2021
    Configuration menu
    Copy the full SHA
    28c0dd8 View commit details
    Browse the repository at this point in the history

  2. Use inline links.

    @ajcvickers
    ajcvickers committed Aug 20, 2021
    Configuration menu
    Copy the full SHA
    e0a366f View commit details
    Browse the repository at this point in the history

  3. Fix using

    @ajcvickers
    ajcvickers committed Aug 20, 2021
    Configuration menu
    Copy the full SHA
    1054413 View commit details
    Browse the repository at this point in the history