tensorflow / tensorflow/text

Broken image links - tutorials loading in the 'guide' url path causing broken images

Open
#1,223 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
1.3k
Forks
379
Avg merge
3h 30m
Merged PRs (30d)
8

Description

I was looking at text embeddings. I did a google search and it sent me to this URL:

https://www.tensorflow.org/text/guide/word_embeddings?hl=en

I immediately noticed a broken image:
image

I did a bit of digging around to see if this would be a trivial fix. But to be honest I'm not quite sure how to fix this.
What I think is happening is that the backend is serving this notebook: docs/tutorials/word_embeddings.ipynb which would normally be accessed at this url: https://www.tensorflow.org/text/tutorials/word_embeddings?hl=en but because the path is now guide/word_embeddings instead of tutorials/word_embeddings. Well tl;dr the embeddings.png is not present there. It's weird that the other images do work.

Anyway I'd like to figure this out and clean this up somehow. I'd love to help with that PR but I'm not sure how this is configured and copying embeddings.png over to guides/images/embeddings.png would work but also feels super gross.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting docs/tutorials/word_embeddings.ipynb and comparing the guide/word_embeddings and tutorials/word_embeddings URLs, including the referenced embeddings.png path. Check the documentation routing or asset configuration that serves the notebook, then verify that the guide URL loads every image without broken links.

Written by the indexing model from the issue text.

Assessment

Tech stack
tensorflow
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.