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

Pass "link summaries" instead of "resolved information" in external documentation source responses #802

Open
d-ronnqvist opened this issue Jan 18, 2024 · 0 comments
Labels
code cleanup Code cleanup *without* user facing changes

Comments

@d-ronnqvist
Copy link
Contributor

Feature Name

Pass "link summaries" instead of "resolved information" in external documentation source responses

Description

Continuing the work from #468; the OutOfProcessReferenceResolver/Response includes OutOfProcessReferenceResolver/ResolvedInformation values which lose some information that's available in LinkDestinationSummary (for example the resolved information abstract in plain text and loses any formatting or links that was in the original abstract). We should update OutOfProcessReferenceResolver to support passing LinkDestinationSummary values and phase out OutOfProcessReferenceResolver/ResolvedInformation

Motivation

There are two main motivations for this change:

  • Not losing information in the content of external pages
  • Avoiding code duplication; OutOfProcessReferenceResolver/ResolvedInformation needs to be kept up to date whenever there are changes to the LinkDestinationSummary data.

Importance

This change will allow formatting and links in external page's abstracts to be preserved.

Alternatives Considered

We could add additional fields to OutOfProcessReferenceResolver/ResolvedInformation for any information that it currently loses compared to LinkDestinationSummary which would give both types the same capabilities but that would make the code duplication and maintenance worse than if we only had one type for this.

@d-ronnqvist d-ronnqvist added the code cleanup Code cleanup *without* user facing changes label Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code cleanup Code cleanup *without* user facing changes
Projects
None yet
Development

No branches or pull requests

1 participant