servicetalk icon indicating copy to clipboard operation
servicetalk copied to clipboard

Links and images are missing in the Docs under the Traffic Resiliency section

Open AshwinJay opened this issue 4 months ago • 2 comments

Hi, I noticed that the SVG diagrams have gone missing from the final, rendered docs even though the files exist in the Github repo.

Here are broken links or incompletely rendered markdown

  • Link not rendered: https://apple.github.io/servicetalk//servicetalk-traffic-resilience-http/SNAPSHOT/traffic-resilience-features.html#peer-capacity-rejections
  • Image and link missing: https://apple.github.io/servicetalk//servicetalk-traffic-resilience-http/SNAPSHOT/traffic-resilience-features.html#architecture
  • Image and link missing: https://apple.github.io/servicetalk//servicetalk-traffic-resilience-http/SNAPSHOT/index.html#concepts

SVGs: https://github.com/apple/servicetalk/tree/main/servicetalk-traffic-resilience-http/docs/modules/ROOT/pages

AshwinJay avatar Aug 23 '25 15:08 AshwinJay

The docs build process (likely Asciidoctor/Antora) may not be bundling static assets correctly.

The docs/modules/ROOT/pages path may need a corresponding docs/modules/ROOT/assets/images directory for Antora to recognize and package images.

Links in .adoc or Markdown files may need to reference the images via image:: or relative xref: rather than direct paths.

How I can help

I can investigate the doc build config (Antora playbook, module structure).

If the issue is just misplaced assets, I can move the .svg files under the expected assets/images directory and update references.

If it’s a build pipeline issue, I can propose adjustments to ensure SVGs are copied correctly.

tusharrrr1 avatar Sep 08 '25 08:09 tusharrrr1

Hey, thank you @AshwinJay for reporting and @tusharrrr1 for providing more context. Somehow I didn't see this issue until now 😕 @tusharrrr1 would you like to dig deeper and prepare a PR?

idelpivnitskiy avatar Nov 19 '25 20:11 idelpivnitskiy