Skip to content

fix: correct js-yaml maintenance status in intro.#816

Open
dreyfus92 wants to merge 1 commit into
mainfrom
fix-docs-1
Open

fix: correct js-yaml maintenance status in intro.#816
dreyfus92 wants to merge 1 commit into
mainfrom
fix-docs-1

Conversation

@dreyfus92

Copy link
Copy Markdown
Member

🔗 Linked issue

closes: #813

📚 Description

updates js-yaml doc updating maintenance status in intro.

Comment thread docs/modules/js-yaml.md
Comment on lines +7 to 8
`js-yaml` is actively maintained. Alternatives below may still be preferable for comment/AST support, zero dependencies, or Bun-native usage.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'd just remove this completely

Suggested change
`js-yaml` is actively maintained. Alternatives below may still be preferable for comment/AST support, zero dependencies, or Bun-native usage.

@dreyfus92 dreyfus92 Jul 17, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

fair on not asserting maintenance status, it'll just rot and we'll end up back here with another issue. but i'd rather not strip the intro entirely, since a reader landing here with no context reads the alternatives as "migrate now, this is dead." how about we drop the status claim and frame it around what the alternatives give you instead:

"The alternatives below can offer better spec compliance, comment/AST support, zero dependencies, or native Bun support."

keeps it accurate, no claim that ages. wdyt?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'd just mention "better spec compliance" and "smaller install size"

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.

js-yaml documentation incorrect

2 participants