Skip to content

Writing changelogs that humans and crawlers both finish

Writing changelogs that humans and crawlers both finish

A good Release has a version, a date, and a list of user-visible changes. Dumping git log into HTML is how you get zero rich results.

We ask staff for three bullets max in the excerpt field (300 characters) and leave the rest in the body. Version tags like v2.9.1 belong on the topic, not only in the title.

5 replies

This is the piece I send to procurement now. The no-cloaking paragraph is the one that matters.

Permalink

Small nit: 1 MB = 1_000_000 bytes in our copy too. Thanks for being explicit.

Permalink

Can you add the UTC timestamp to the first paragraph so crawlers get a clear date?

Permalink

We cited this from /llms.txt. The canonical on the article itself is correct.

Permalink

Thanks — leaving this up for the next team that searches the same string.

Permalink

Weekly winners

Writing changelogs that humans and crawlers both finish

A good Release has a version, a date, and a list of user-visible changes. Dumping git log into HTML is how you get zero rich results.

We ask staff for three bullets max in the excerpt field (300 characters) and leave the rest in the body. Version tags like v2.9.1 belong on the topic, not only in the title.

Replies 5

Hana Sato
Member

@hana_research

This is the piece I send to procurement now. The no-cloaking paragraph is the one that matters.

Sarah Chen
StaffRegular

@sarah_product

Small nit: 1 MB = 1_000_000 bytes in our copy too. Thanks for being explicit.

Priya Nair

@priya_data

Can you add the UTC timestamp to the first paragraph so crawlers get a clear date?

Marcus Vance

@marcus_dev

We cited this from /llms.txt. The canonical on the article itself is correct.

Hana Sato
Member

@hana_research

Thanks — leaving this up for the next team that searches the same string.

Join the conversation

Sign in or create an account to share your thoughts, solutions, or feedback.