Skip to content

fix: broken link in v6 docs README for Nablarch 6u2 (#326)#331

Open
kiyotis wants to merge 11 commits intomainfrom
326-fix-broken-link-readme
Open

fix: broken link in v6 docs README for Nablarch 6u2 (#326)#331
kiyotis wants to merge 11 commits intomainfrom
326-fix-broken-link-readme

Conversation

@kiyotis
Copy link
Copy Markdown
Contributor

@kiyotis kiyotis commented May 7, 2026

Closes #326

Approach

The link target filename contained a literal space: releases-nablarch6u2-releasenote-6u2 (6u1からの変更点).md. Markdown link parsers treat unencoded spaces as link terminators, so the link rendered as plain text. Fixed by URL-encoding the space as %20, which GitHub and CommonMark renderers correctly decode when resolving file paths.

A horizontal scan of the README confirmed no other links contain unencoded spaces.

docs.py also fixed to encode spaces at create-time so the manual %20 fix survives subsequent create/verify cycles. Initial fix used urllib.parse.quote() which encoded Japanese characters too; narrowed to str.replace(" ", "%20") to avoid corrupting the 161 existing Japanese paths across 5 README files.

Tasks

See tasks.md.

Expert Review

AI-driven expert reviews conducted before PR creation (see .claude/rules/expert-review.md):

Success Criteria Check

Criterion Status Evidence
The link in README.md renders correctly and navigates to the target file ✅ Met .claude/skills/nabledge-6/docs/README.md line 371: space encoded as %20
Future create runs preserve the %20 encoding ✅ Met docs.py uses str.replace(" ", "%20"); 18 unit tests pass

🤖 Generated with Claude Code

@kiyotis kiyotis added the bug Something isn't working label May 7, 2026
Comment thread .claude/skills/nabledge-6/docs/README.md
kiyotis and others added 7 commits May 7, 2026 17:04
Space in the filename broke Markdown link parsing — encoded as %20 so the
link resolves correctly in GitHub and CommonMark renderers.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
docs.py generated README.md with raw spaces in file paths; next create
run would have reverted the manual %20 fix. quote() now encodes spaces
permanently so links survive create/verify cycles.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Re-run of expert review requested by reviewer after source code changes
(docs.py URL-encoding fix + test_docs.py TestReadmeUrlEncoding class).
Both reviews: 0 Findings.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
quote() encoded Japanese characters too, which would corrupt 161
existing valid Japanese paths across 5 README files on next create run.
Use str.replace(" ", "%20") to fix only the character that breaks
Markdown link parsing; other non-ASCII chars are valid GitHub link targets.

Added test_readme_does_not_encode_japanese_in_filename as regression guard.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@kiyotis kiyotis force-pushed the 326-fix-broken-link-readme branch from a710d7e to 49d0a9c Compare May 7, 2026 08:09
kiyotis and others added 4 commits May 7, 2026 17:12
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: broken link in v6 docs README for Nablarch 6u2 release note

1 participant