Skip to content

docs: #291 document encoding expectations for frontmatter values and dynamic route params - #292

Open
jstockdi wants to merge 1 commit into
ProjectEvergreen:mainfrom
Battle-Creek-LLC:docs/issue-291-encoding-expectations
Open

jstockdi wants to merge 1 commit into
ProjectEvergreen:mainfrom
Battle-Creek-LLC:docs/issue-291-encoding-expectations

Conversation

@jstockdi

@jstockdi jstockdi commented Aug 2, 2026

Copy link
Copy Markdown

Summary

Closes #291 — documents the encoding expectations for frontmatter values and dynamic route params, per the discussion on ProjectEvergreen/greenwood#1710.

Changes

  • Frontmatter (/docs/content-as-data/frontmatter/): new "Special Characters" section — a literal % passes through to the output verbatim, percent-encoded values decode once, and the same rules apply to pages from source plugins so both content APIs behave identically.
  • Server Rendering (/docs/pages/server-rendering/): note under Dynamic Prerendering — getStaticPaths param values round-trip decoded (spaces, non-ASCII, literal %), while emitted folder names are percent-encoded to stay URL-safe.

Timing

The documented behavior lands in the CLI with ProjectEvergreen/greenwood#1710 and ProjectEvergreen/greenwood#1714, so this should merge alongside or after the release line that includes them.

@netlify

netlify Bot commented Aug 2, 2026

Copy link
Copy Markdown

Deploy Preview for super-tapioca-5987ce ready!

Name Link
🔨 Latest commit 348cda1
🔍 Latest deploy log https://app.netlify.com/projects/super-tapioca-5987ce/deploys/6a6f1baac29a0f000818c899
😎 Deploy Preview https://deploy-preview-292--super-tapioca-5987ce.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@jstockdi jstockdi self-assigned this Aug 2, 2026

@thescientist13 thescientist13 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to avoid using LLM output for documentation, if we could. Unlike code, documentation is direct communication to our users, and so emdashes and "robotic" language (obvious signs of LLM usage) is not something I feel good about publishing.

Documentation should be for developers by developers. Could you please re-write using your own words please?

Thanks!

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.

Document encoding expectations for frontmatter values and dynamic route params

2 participants