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

Impact and design constraints for site/XRef builds #1759

Open
agoose77 opened this issue Jan 10, 2025 · 1 comment
Open

Impact and design constraints for site/XRef builds #1759

agoose77 opened this issue Jan 10, 2025 · 1 comment
Labels
meta Meta discussions, not for development

Comments

@agoose77
Copy link
Contributor

agoose77 commented Jan 10, 2025

With MyST, we are positioning XRefs as the way to share content. That means we're encouraging scholarly authors to use XRefs to connect content across their own work, and further afield.

But, we currently build and deploy XRef information through a site build, which implicitly encodes assumptions about the web vs print distinction, such as image formats. Further down the road, we will increasingly want to distinguish how content is handled on web and print, and we must be careful not to end up in a situation where XRef content performs poorly when embedded in e.g. print media.

A concise summary of this topic is that we need to be careful to treat XRefs as a canonical sharing format.

Things to think about

  • image resolution / formats
  • only branching nodes
  • placeholder types
@agoose77 agoose77 added the meta Meta discussions, not for development label Jan 14, 2025
@agoose77 agoose77 changed the title Meta issue to track XRef concepts Impact and design constraints for site/xref builds. Jan 14, 2025
@agoose77 agoose77 changed the title Impact and design constraints for site/xref builds. Impact and design constraints for site/XRef builds Jan 14, 2025
@agoose77
Copy link
Contributor Author

Tagging @rowanc1 and @stevejpurves as people that have spoken about this recently.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Meta discussions, not for development
Projects
None yet
Development

No branches or pull requests

1 participant