Skip to content

fix(docs): make the operating page front matter valid YAML - #277

Merged
alpergundogdu merged 1 commit into
mainfrom
fix/docs-operating-frontmatter
Oct 9, 2026
Merged

alpergundogdu merged 1 commit into
mainfrom
fix/docs-operating-frontmatter

Conversation

@alpergundogdu

Copy link
Copy Markdown
Contributor

Summary

https://docs.decdn.org/run-a-node/operating returns 404, while the other eight run-a-node pages from #276 return 200.

The cause is the page's front matter. Its unquoted description contains : ("…of a deCDN node: status commands…"), and YAML parses that as a nested mapping, so the front matter is invalid and Mintlify drops the page. Prettier, markdownlint and mintlify broken-links all pass on it, because none of them parse front matter as YAML. The fix rewords the description so it has no colon.

Test plan

  • Every docs/**/*.mdx front matter parses with js-yaml (23 files, 0 errors). The old version fails with bad indentation of a mapping entry.
  • prettier --check
  • After merge: https://docs.decdn.org/run-a-node/operating returns 200

🤖 Generated with Claude Code

An unquoted description containing ": " parses as a nested mapping, so
Mintlify dropped the page and /run-a-node/operating returned 404.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings October 9, 2026 10:46
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying website with  Cloudflare Pages  Cloudflare Pages

Latest commit: 051aa22
Status: ✅  Deploy successful!
Preview URL: https://ec35b32a.website-70y.pages.dev
Branch Preview URL: https://fix-docs-operating-frontmatt.website-70y.pages.dev

View logs

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approval recommended

The one-line reword produces valid YAML front matter, matches the unquoted-description convention used by all other docs pages, and no other file has the same defect.

0 open findings

What changed in this PR

This PR fixes a 404 on https://docs.decdn.org/run-a-node/operating caused by invalid YAML front matter. The page's unquoted description contained : ("…deCDN node: status commands…"), which YAML interprets as a nested mapping, making the front matter invalid so Mintlify drops the page. Prettier, markdownlint, and mintlify broken-links don't parse front matter as YAML, so none caught it. The fix rewords the description to remove the colon, keeping it a valid single-line plain scalar. This complements the run-a-node operator guide added in #276.

Changes:

  • Rewords the operating.mdx front-matter description, replacing the : after "deCDN node" with ", covering" so the YAML parses correctly.
File Description
docs/​run-a-node/​operating.mdx Rewrites the front-matter description to eliminate the colon-space that broke YAML parsing and caused the page's 404.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@alpergundogdu
alpergundogdu merged commit d11f4d0 into main Oct 9, 2026
8 checks passed
@alpergundogdu
alpergundogdu deleted the fix/docs-operating-frontmatter branch October 9, 2026 10:48
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.

2 participants