Skip to content

okf: clarify URL encoding for cross-link targets (SPEC 5.4)#186

Open
manumishra12 wants to merge 1 commit into
GoogleCloudPlatform:mainfrom
manumishra12:spec-clarify-link-url-encoding
Open

okf: clarify URL encoding for cross-link targets (SPEC 5.4)#186
manumishra12 wants to merge 1 commit into
GoogleCloudPlatform:mainfrom
manumishra12:spec-clarify-link-url-encoding

Conversation

@manumishra12

Copy link
Copy Markdown

What

Adds a short subsection (SPEC section 5.4, "Link target encoding") clarifying whether OKF cross-link targets require URL/percent encoding — something section 5 does not currently address.

Clarification

  • Link targets are ordinary markdown/CommonMark destinations resolved as bundle paths, not pre-encoded URLs.
  • Producers SHOULD keep path segments URL-safe so no encoding is needed and a link resolves the same whether treated as a file path or a URL.
  • When a segment must contain a URL-unsafe character (for example a space), it MAY be percent-encoded per CommonMark, and consumers resolving against the filesystem SHOULD percent-decode before matching it to a concept path.

Additive and backward-compatible (SPEC section 11 minor-version rules); no existing bundle changes meaning.

Addresses #112.

Section 5 did not state whether link targets require URL/percent encoding.
Adds a short subsection: targets are ordinary markdown/CommonMark destinations
resolved as bundle paths; keep segments URL-safe so no encoding is needed, and
when a segment must carry a URL-unsafe character it MAY be percent-encoded and
consumers SHOULD percent-decode before matching.

Additive and backward-compatible. Addresses GoogleCloudPlatform#112.
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.

1 participant