Skip to content

docs: README images and nav links broken on PyPI (relative paths not resolved) - #216

Closed
Elkero (YuuGR1337) wants to merge 1 commit into
responsibleai:mainfrom
YuuGR1337:fix/issue-211
Closed

docs: README images and nav links broken on PyPI (relative paths not resolved)#216
Elkero (YuuGR1337) wants to merge 1 commit into
responsibleai:mainfrom
YuuGR1337:fix/issue-211

Conversation

@YuuGR1337

Copy link
Copy Markdown

Fixes #211


@changliu2

Copy link
Copy Markdown
Collaborator

Review: close in favor of #214

Thanks for picking this up, Elkero (@YuuGR1337). The one URL you changed is correct (verified 200 on https://raw.githubusercontent.com/responsibleai/ASSERT/main/assets/assert-logo.png), but this PR is an incomplete subset of what issue #211 requires.

Completeness check against issue #211

Issue #211 lists three categories of broken renderings on PyPI: the logo image, the framework diagram image, and the nav links (Get started / Targets / CLI / Examples). It also notes the LICENSE badge link, the walkthrough table cell, and the Concept Doc link are relative. This PR only rewrites 1 of 7 relative URLs in README.md:

Relative path on main Fixed in #216 Fixed in #214
assets/assert-logo.png (line 2)
docs/getting-started.md (nav)
docs/targets/callable.md (nav)
docs/cli/overview.md (nav)
examples/README.md (nav)
LICENSE (badge link)
assets/assert-ai-framework-diagram.png
docs/getting-started.md (table cell)
docs/concepts.md#risks-and-limitations

After merging #216 the PyPI page would still 404 on every nav link and still fail to render the framework diagram, so AC #1 and AC #2 in issue #211 are not satisfied.

Comparison vs #214

Same approach (rewrite relative paths to absolute raw.githubusercontent.com / github.com/.../blob/main/... URLs), same pin choice (/main/), same target org. #214 is a strict superset: +9/-9 vs +1/-1, and covers every relative reference flagged in #211.

Verdict

Close in favor of #214. No code-quality concerns here — the change is correct as far as it goes — but shipping only the logo fix would leave the bug effectively unfixed on PyPI and bake an incomplete state into the next immutable release. If #214 stalls, this PR would need to expand to cover the remaining 8 references before it can close #211.

(Note: an automated audit of #214 is running in parallel; if it surfaces a blocker there, we'll revisit.)

@changliu2

Copy link
Copy Markdown
Collaborator

Closing in favor of #214, which covers the same PyPI README link/image fixes more comprehensively. Thanks for catching this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: README images and nav links broken on PyPI (relative paths not resolved)

2 participants