feat: add official_doc_urls and hints to browsable markdown (#155)#167
Merged
feat: add official_doc_urls and hints to browsable markdown (#155)#167
Conversation
Add official documentation URLs and keyword hints to browsable markdown output in phase_f_finalize.py. Regenerate all nabledge-6 knowledge docs with the new format. Add unit tests for multiple-URL rendering and empty field edge cases. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
kiyotis
commented
Mar 10, 2026
kiyotis
commented
Mar 10, 2026
Replace keyword hints format from <small>キーワード: ...</small> to *キーワード: ...* since <small> HTML tags do not render as smaller text in GitHub Markdown. Also revert unintended catalog.json timestamp change and add CHANGELOG entry for official doc URL feature. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Regenerate all 290 nabledge-6 browsable markdown docs using Phase M (delete-insert pattern) to apply the details tag format for keywords consistently across all files. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #155
Approach
Added
official_doc_urlsand per-sectionhintsfields to the browsable markdown output generated byphase_f_finalize.py. Previously, these fields existed only in the JSON knowledge files and required developers to open JSON directly to review URLs and keyword quality.The approach:
**公式ドキュメント**: [title](url)(single URL) or numbered links[1](url1) [2](url2)(multiple URLs)<small>キーワード: ...</small>if urls:,if hints:) handle empty lists cleanlyThis approach was chosen because the formatting is minimal and non-disruptive, fits cleanly within the existing
_generate_docsloop, and makes keyword and URL correctness visible directly in PR diffs.Tasks
_generate_docsinphase_f_finalize.pyto emit**公式ドキュメント**block at file top_generate_docsto emit<small>キーワード: ...</small>block after each sectiontest_merge_then_resolve_then_docstest_docs_multiple_official_urlsfor numbered-link renderingtest_docs_empty_official_urls_and_hintsfor empty field edge casesExpert Review
AI-driven expert reviews conducted before PR creation (see
.claude/rules/expert-review.md):Success Criteria Check
official_doc_urlsat the top of the file as a linkphase_f_finalize.pyemits**公式ドキュメント**: [title](url)block; verified intest_merge_then_resolve_then_docsandtest_docs_multiple_official_urlshints) at the end of each section in<small>tagsphase_f_finalize.pyemits<small>キーワード: ...</small>after each section; verified intest_merge_then_resolve_then_docsandtest_docs_multiple_official_urlsphase_f_finalize.pyupdated and all 289 docs regenerated🤖 Generated with Claude Code