Skip to content

docs(resources): document Markdown image URI rewrites#2573

Open
r266-tech wants to merge 1 commit into
volcengine:mainfrom
r266-tech:docs-resource-image-uri-rewrite
Open

docs(resources): document Markdown image URI rewrites#2573
r266-tech wants to merge 1 commit into
volcengine:mainfrom
r266-tech:docs-resource-image-uri-rewrite

Conversation

@r266-tech

Copy link
Copy Markdown
Contributor

Summary

  • document that local Markdown image embeds are copied during resource ingest and rewritten to viking://... URIs after persistence
  • cover both Markdown ![alt](...) references and HTML <img src="..."> embeds
  • mirror the note in the English and Chinese resource API docs

Source

This follows #2557, which added local image ingestion and post-commit URI rewriting for Markdown directory and re-ingest flows.

Checks

  • git diff --check

Dual KPI

Real value: users importing Markdown directories can predict what happens to local image references instead of assuming those links break or require manual upload.

Farming risk: low; this is a small bilingual docs-code drift update tied to a merged parser behavior, not formatting churn.

@github-actions

Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

2557 - Fully compliant

Compliant requirements:

  • Document local Markdown image embeds are copied and rewritten to viking:// URIs on resource ingest
  • Cover both Markdown alt and HTML formats
  • Mirror the note in English and Chinese resource API docs
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 100
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@github-actions

Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

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

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

1 participant