Skip to content

feat(cli): add page-size configuration option for changelog pagination #12061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(cli): add page-size configuration option for changelog pagination #12061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
407de65
feat: add page-size configuration option for changelog pagination
devin-ai-integration[bot] Feb 4, 2026
04f0710
Merge origin/main into devin/1770223512-changelog-page-size
devin-ai-integration[bot] Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions fern/apis/docs-yml/definition/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1058,6 +1058,10 @@ types:
slug: optional<string>
icon: optional<string>
hidden: optional<boolean>
page-size:
type: optional<integer>
docs: |
The number of changelog entries to display per page. If not specified, all entries are displayed on a single page.
# skip-slug: optional<boolean> # skip-slug is not needed for changelog

SectionConfiguration:
Expand Down
8 changes: 8 additions & 0 deletions packages/cli/cli/versions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# yaml-language-server: $schema=../../../fern-versions-yml.schema.json
- version: 3.64.0
changelogEntry:
- summary: |
Add `page-size` configuration option for changelog navigation items. This allows users to control how many changelog entries are displayed per page. If not specified, all entries are displayed on a single page.
type: feat
createdAt: "2026-02-04"
irVersion: 63

- version: 3.63.0
changelogEntry:
- summary: |
Expand Down
1 change: 1 addition & 0 deletions packages/cli/configuration-loader/src/docs-yml/parseDocsConfiguration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1088,6 +1088,7 @@ async function convertNavigationItem({
icon: resolveIconPath(rawConfig.icon, absolutePathToConfig),
title: rawConfig.title ?? DEFAULT_CHANGELOG_TITLE,
slug: rawConfig.slug,
pageSize: rawConfig.pageSize,
viewers: parseRoles(rawConfig.viewers),
orphaned: rawConfig.orphaned,
featureFlags: convertFeatureFlag(rawConfig.featureFlag)
Expand Down
1 change: 1 addition & 0 deletions packages/cli/configuration/src/docs-yml/ParsedDocsConfiguration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,7 @@ export declare namespace DocsNavigationItem {
icon: string | AbsoluteFilePath | undefined;
hidden: boolean | undefined;
slug: string | undefined;
pageSize: number | undefined;
}

export interface PythonDocsSection {
Expand Down
2 changes: 2 additions & 0 deletions ...configuration/src/docs-yml/schemas/sdk/api/resources/docs/types/ChangelogConfiguration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ export interface ChangelogConfiguration extends FernDocsConfig.WithPermissions,
slug?: string;
icon?: string;
hidden?: boolean;
/** The number of changelog entries to display per page. If not specified, all entries are displayed on a single page. */
pageSize?: number;
}
2 changes: 2 additions & 0 deletions ...ion/src/docs-yml/schemas/sdk/serialization/resources/docs/types/ChangelogConfiguration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export const ChangelogConfiguration: core.serialization.ObjectSchema<
slug: core.serialization.string().optional(),
icon: core.serialization.string().optional(),
hidden: core.serialization.boolean().optional(),
pageSize: core.serialization.property("page-size", core.serialization.number().optional()),
})
.extend(WithPermissions)
.extend(WithFeatureFlags);
Expand All @@ -28,5 +29,6 @@ export declare namespace ChangelogConfiguration {
slug?: string | null;
icon?: string | null;
hidden?: boolean | null;
"page-size"?: number | null;
}
}
2 changes: 2 additions & 0 deletions packages/cli/docs-resolver/src/ChangelogNodeConverter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ interface ConvertOptions {
icon?: string;
hidden?: boolean;
slug?: string;
pageSize?: number;
viewers?: APIV1Write.RoleId[];
orphaned?: boolean;
// skipUrlSlug?: boolean;
Expand Down Expand Up @@ -119,6 +120,7 @@ export class ChangelogNodeConverter {
children: changelogYears,
overviewPageId,
noindex,
pageSize: opts.pageSize,
authed: undefined,
viewers: opts.viewers,
orphaned: opts.orphaned,
Expand Down
3 changes: 2 additions & 1 deletion packages/cli/docs-resolver/src/DocsDefinitionResolver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1498,7 +1498,8 @@ export class DocsDefinitionResolver {
icon: this.resolveIconFileId(item.icon),
viewers: item.viewers,
hidden: hideChildren || item.hidden,
slug: item.slug
slug: item.slug,
pageSize: item.pageSize
});
}

Expand Down
Loading