Skip to content

docs: ship the public changelog entries in the doc package - #1304

Merged
BryanFRD merged 1 commit into
mainfrom
feat/doc-ships-changelog
Oct 10, 2026
Merged

BryanFRD merged 1 commit into
mainfrom
feat/doc-ships-changelog

Conversation

@BryanFRD

Copy link
Copy Markdown
Contributor

Closes #1303

FerrLabs/Changelog is being retired: each product keeps its public changelog entries next to its code, and ferrlabs.com now shows only FerrLabs entries. ferrflow.com still downloads FerrLabs/Changelog from main at build time.

  • docs/site/changelog/ holds the 82 FerrFlow entries, copied byte for byte from FerrLabs/Changelog. docs/site is the @ferrflow/doc package, so they ship with the next release; FerrFlow-Cloud will read them from the package instead of fetching the Changelog repo. The site docs validator only looks at docs-* directories, so the new one does not affect it.
  • CONTRIBUTING now says where an entry goes and when one is due: in docs/site/changelog/, in the same pull request as the change.
  • The README's Changelog link pointed at ferrlabs.com, which no longer lists FerrFlow entries; it now points at ferrflow.com/changelog.

docs: as CONTRIBUTING asks for a documentation-only change; the entries reach the package with the next feat or fix release.

@BryanFRD
BryanFRD enabled auto-merge (squash) October 10, 2026 10:37

@ferrfleet ferrfleet Bot left a comment

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.

Nothing blocking. docs/site/package.json has no files allowlist and there is no .npmignore, so changelog/ ships in @ferrflow/doc as intended. The CONTRIBUTING frontmatter spec matches the keys the entries use, and the README link fix is correct.

I did not review the entry prose, since it is a byte-for-byte copy of FerrLabs/Changelog.

@BryanFRD
BryanFRD merged commit 92a5a95 into main Oct 10, 2026
31 checks passed
@BryanFRD
BryanFRD deleted the feat/doc-ships-changelog branch October 10, 2026 10:39
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.

docs: keep the FerrFlow changelog entries in this repository

1 participant