@cbnventures/nova 0.22.6 → 0.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/package.json +1 -1
- package/build/src/cli/generate/github/workflows-blueprint.d.ts +1 -0
- package/build/src/cli/generate/github/workflows-blueprint.d.ts.map +1 -1
- package/build/src/cli/generate/github/workflows-blueprint.js +131 -187
- package/build/src/cli/generate/github/workflows-blueprint.js.map +1 -1
- package/build/src/cli/recipe/github/gh-precheck.d.ts +3 -0
- package/build/src/cli/recipe/github/gh-precheck.d.ts.map +1 -0
- package/build/src/cli/recipe/github/gh-precheck.js +111 -0
- package/build/src/cli/recipe/github/gh-precheck.js.map +1 -0
- package/build/src/cli/recipe/github/sync-features.d.ts.map +1 -1
- package/build/src/cli/recipe/github/sync-features.js +8 -98
- package/build/src/cli/recipe/github/sync-features.js.map +1 -1
- package/build/src/cli/recipe/github/sync-identity.d.ts.map +1 -1
- package/build/src/cli/recipe/github/sync-identity.js +10 -98
- package/build/src/cli/recipe/github/sync-identity.js.map +1 -1
- package/build/src/cli/recipe/github/sync-policies.d.ts.map +1 -1
- package/build/src/cli/recipe/github/sync-policies.js +8 -98
- package/build/src/cli/recipe/github/sync-policies.js.map +1 -1
- package/build/src/cli/recipe/package-json/normalize-artifacts.d.ts +0 -1
- package/build/src/cli/recipe/package-json/normalize-artifacts.d.ts.map +1 -1
- package/build/src/cli/recipe/package-json/normalize-artifacts.js +6 -21
- package/build/src/cli/recipe/package-json/normalize-artifacts.js.map +1 -1
- package/build/src/cli/recipe/package-json/normalize-dependencies.d.ts +0 -1
- package/build/src/cli/recipe/package-json/normalize-dependencies.d.ts.map +1 -1
- package/build/src/cli/recipe/package-json/normalize-dependencies.js +8 -23
- package/build/src/cli/recipe/package-json/normalize-dependencies.js.map +1 -1
- package/build/src/cli/recipe/package-json/normalize-tooling.d.ts +0 -1
- package/build/src/cli/recipe/package-json/normalize-tooling.d.ts.map +1 -1
- package/build/src/cli/recipe/package-json/normalize-tooling.js +2 -17
- package/build/src/cli/recipe/package-json/normalize-tooling.js.map +1 -1
- package/build/src/cli/recipe/package-json/sync-environment.d.ts +0 -1
- package/build/src/cli/recipe/package-json/sync-environment.d.ts.map +1 -1
- package/build/src/cli/recipe/package-json/sync-environment.js +4 -19
- package/build/src/cli/recipe/package-json/sync-environment.js.map +1 -1
- package/build/src/cli/utility/changelog.d.ts.map +1 -1
- package/build/src/cli/utility/changelog.js +179 -86
- package/build/src/cli/utility/changelog.js.map +1 -1
- package/build/src/cli/utility/initialize.d.ts +1 -0
- package/build/src/cli/utility/initialize.d.ts.map +1 -1
- package/build/src/cli/utility/initialize.js +61 -0
- package/build/src/cli/utility/initialize.js.map +1 -1
- package/build/src/lib/item.d.ts.map +1 -1
- package/build/src/lib/item.js +4 -1
- package/build/src/lib/item.js.map +1 -1
- package/build/src/lib/nova-config.d.ts.map +1 -1
- package/build/src/lib/nova-config.js +4 -0
- package/build/src/lib/nova-config.js.map +1 -1
- package/build/src/lib/utility.d.ts +2 -1
- package/build/src/lib/utility.d.ts.map +1 -1
- package/build/src/lib/utility.js +15 -0
- package/build/src/lib/utility.js.map +1 -1
- package/build/src/types/cli/generate/github/workflows-blueprint.d.ts +39 -0
- package/build/src/types/cli/recipe/github/gh-precheck.d.ts +86 -0
- package/build/src/types/cli/recipe/github/sync-features.d.ts +6 -43
- package/build/src/types/cli/recipe/github/sync-identity.d.ts +6 -40
- package/build/src/types/cli/recipe/github/sync-policies.d.ts +6 -43
- package/build/src/types/cli/recipe/package-json/normalize-artifacts.d.ts +0 -9
- package/build/src/types/cli/recipe/package-json/normalize-dependencies.d.ts +0 -9
- package/build/src/types/cli/recipe/package-json/normalize-tooling.d.ts +0 -9
- package/build/src/types/cli/recipe/package-json/sync-environment.d.ts +0 -9
- package/build/src/types/cli/utility/changelog.d.ts +25 -2
- package/build/src/types/cli/utility/initialize.d.ts +53 -0
- package/build/src/types/lib/item.d.ts +1 -1
- package/build/src/types/lib/nova-config.d.ts +4 -0
- package/build/src/types/lib/utility.d.ts +9 -0
- package/build/src/types/shared.d.ts +10 -2
- package/build/src/types/tests/cli/utility/changelog.test.d.ts +179 -0
- package/build/src/types/tests/lib/item.test.d.ts +14 -0
- package/build/templates/generators/must-haves/agent-conventions/conventions/documentation.md +19 -8
- package/build/templates/scaffold/docs/docusaurus/package.json +2 -2
- package/package.json +1 -1
|
@@ -11,6 +11,158 @@ export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SandboxPrefix = s
|
|
|
11
11
|
|
|
12
12
|
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SandboxRoot = string;
|
|
13
13
|
|
|
14
|
+
/**
|
|
15
|
+
* Tests - CLI - Utility - Changelog - Run - CalVer Entry With Bump Field Errors.
|
|
16
|
+
*
|
|
17
|
+
* @since 0.23.0
|
|
18
|
+
*/
|
|
19
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverEntryWithBumpFieldErrors_ProjectDirectory = string;
|
|
20
|
+
|
|
21
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverEntryWithBumpFieldErrors_WorkspaceDirectory = string;
|
|
22
|
+
|
|
23
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverEntryWithBumpFieldErrors_ChangelogDirectory = string;
|
|
24
|
+
|
|
25
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverEntryWithBumpFieldErrors_PackageJsonPath = string;
|
|
26
|
+
|
|
27
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverEntryWithBumpFieldErrors_PackageJsonContents = string;
|
|
28
|
+
|
|
29
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverEntryWithBumpFieldErrors_ConfigPath = string;
|
|
30
|
+
|
|
31
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverEntryWithBumpFieldErrors_ConfigContents = string;
|
|
32
|
+
|
|
33
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverEntryWithBumpFieldErrors_WorkspacePackagePath = string;
|
|
34
|
+
|
|
35
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverEntryWithBumpFieldErrors_WorkspacePackageContents = string;
|
|
36
|
+
|
|
37
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverEntryWithBumpFieldErrors_EntryPath = string;
|
|
38
|
+
|
|
39
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverEntryWithBumpFieldErrors_EntryContents = string;
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* Tests - CLI - Utility - Changelog - Run - CalVer Record Omits Bump From Entry File.
|
|
43
|
+
*
|
|
44
|
+
* @since 0.23.0
|
|
45
|
+
*/
|
|
46
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_ProjectDirectory = string;
|
|
47
|
+
|
|
48
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_PackageJsonPath = string;
|
|
49
|
+
|
|
50
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_PackageJsonContents = string;
|
|
51
|
+
|
|
52
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_ConfigPath = string;
|
|
53
|
+
|
|
54
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_ConfigContents = string;
|
|
55
|
+
|
|
56
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_ChangelogDirectory = string;
|
|
57
|
+
|
|
58
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_Files = string[];
|
|
59
|
+
|
|
60
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_MdFiles = string[];
|
|
61
|
+
|
|
62
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_MdFile = string;
|
|
63
|
+
|
|
64
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_EntryPath = string;
|
|
65
|
+
|
|
66
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_Content = string;
|
|
67
|
+
|
|
68
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_HasBump = boolean;
|
|
69
|
+
|
|
70
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_HasPackage = boolean;
|
|
71
|
+
|
|
72
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverRecordOmitsBumpFromEntryFile_HasCategory = boolean;
|
|
73
|
+
|
|
74
|
+
/**
|
|
75
|
+
* Tests - CLI - Utility - Changelog - Run - CalVer Release Computes Version From Date.
|
|
76
|
+
*
|
|
77
|
+
* @since 0.23.0
|
|
78
|
+
*/
|
|
79
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_ProjectDirectory = string;
|
|
80
|
+
|
|
81
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_WorkspaceDirectory = string;
|
|
82
|
+
|
|
83
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_ChangelogDirectory = string;
|
|
84
|
+
|
|
85
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_PackageJsonPath = string;
|
|
86
|
+
|
|
87
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_PackageJsonContents = string;
|
|
88
|
+
|
|
89
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_ConfigPath = string;
|
|
90
|
+
|
|
91
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_ConfigContents = string;
|
|
92
|
+
|
|
93
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_WorkspacePackagePath = string;
|
|
94
|
+
|
|
95
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_WorkspacePackageContents = string;
|
|
96
|
+
|
|
97
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_EntryPath = string;
|
|
98
|
+
|
|
99
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_EntryContents = string;
|
|
100
|
+
|
|
101
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_UpdatedPackagePath = string;
|
|
102
|
+
|
|
103
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_PackageJsonRaw = string;
|
|
104
|
+
|
|
105
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_PackageJson = Record<string, unknown>;
|
|
106
|
+
|
|
107
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_ExpectedYear = number;
|
|
108
|
+
|
|
109
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_ExpectedMonth = number;
|
|
110
|
+
|
|
111
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_ExpectedVersion = string;
|
|
112
|
+
|
|
113
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_ChangelogPath = string;
|
|
114
|
+
|
|
115
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_ChangelogContent = string;
|
|
116
|
+
|
|
117
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_HasVersionHeading = boolean;
|
|
118
|
+
|
|
119
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_HasDateSuffix = boolean;
|
|
120
|
+
|
|
121
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_RemainingFiles = string[];
|
|
122
|
+
|
|
123
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseComputesVersionFromDate_RemainingMdFiles = string[];
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* Tests - CLI - Utility - Changelog - Run - CalVer Release Increments Micro Within Same Month.
|
|
127
|
+
*
|
|
128
|
+
* @since 0.23.0
|
|
129
|
+
*/
|
|
130
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_ProjectDirectory = string;
|
|
131
|
+
|
|
132
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_WorkspaceDirectory = string;
|
|
133
|
+
|
|
134
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_ChangelogDirectory = string;
|
|
135
|
+
|
|
136
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_PackageJsonPath = string;
|
|
137
|
+
|
|
138
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_PackageJsonContents = string;
|
|
139
|
+
|
|
140
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_ConfigPath = string;
|
|
141
|
+
|
|
142
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_ConfigContents = string;
|
|
143
|
+
|
|
144
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_CurrentYear = number;
|
|
145
|
+
|
|
146
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_CurrentMonth = number;
|
|
147
|
+
|
|
148
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_CurrentVersion = string;
|
|
149
|
+
|
|
150
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_WorkspacePackagePath = string;
|
|
151
|
+
|
|
152
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_WorkspacePackageContents = string;
|
|
153
|
+
|
|
154
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_EntryPath = string;
|
|
155
|
+
|
|
156
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_EntryContents = string;
|
|
157
|
+
|
|
158
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_UpdatedPackagePath = string;
|
|
159
|
+
|
|
160
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_PackageJsonRaw = string;
|
|
161
|
+
|
|
162
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_PackageJson = Record<string, unknown>;
|
|
163
|
+
|
|
164
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_CalverReleaseIncrementsMicroWithinSameMonth_ExpectedVersion = string;
|
|
165
|
+
|
|
14
166
|
/**
|
|
15
167
|
* Tests - CLI - Utility - Changelog - Run - Dry Run Leaves UNRELEASED Tokens In Place.
|
|
16
168
|
*
|
|
@@ -292,6 +444,33 @@ export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_ReleasesAndBumpsV
|
|
|
292
444
|
|
|
293
445
|
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_ReleasesAndBumpsVersion_RemainingMdFiles = string[];
|
|
294
446
|
|
|
447
|
+
/**
|
|
448
|
+
* Tests - CLI - Utility - Changelog - Run - SemVer Entry Without Bump Field Errors.
|
|
449
|
+
*
|
|
450
|
+
* @since 0.23.0
|
|
451
|
+
*/
|
|
452
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SemverEntryWithoutBumpFieldErrors_ProjectDirectory = string;
|
|
453
|
+
|
|
454
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SemverEntryWithoutBumpFieldErrors_WorkspaceDirectory = string;
|
|
455
|
+
|
|
456
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SemverEntryWithoutBumpFieldErrors_ChangelogDirectory = string;
|
|
457
|
+
|
|
458
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SemverEntryWithoutBumpFieldErrors_PackageJsonPath = string;
|
|
459
|
+
|
|
460
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SemverEntryWithoutBumpFieldErrors_PackageJsonContents = string;
|
|
461
|
+
|
|
462
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SemverEntryWithoutBumpFieldErrors_ConfigPath = string;
|
|
463
|
+
|
|
464
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SemverEntryWithoutBumpFieldErrors_ConfigContents = string;
|
|
465
|
+
|
|
466
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SemverEntryWithoutBumpFieldErrors_WorkspacePackagePath = string;
|
|
467
|
+
|
|
468
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SemverEntryWithoutBumpFieldErrors_WorkspacePackageContents = string;
|
|
469
|
+
|
|
470
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SemverEntryWithoutBumpFieldErrors_EntryPath = string;
|
|
471
|
+
|
|
472
|
+
export type Tests_Cli_Utility_Changelog_CliUtilityChangelogRun_SemverEntryWithoutBumpFieldErrors_EntryContents = string;
|
|
473
|
+
|
|
295
474
|
/**
|
|
296
475
|
* Tests - CLI - Utility - Changelog - Run - Skips Release When No Entries Exist.
|
|
297
476
|
*
|
|
@@ -40,6 +40,20 @@ export type Tests_Lib_Item_AllowedRolesAndPolicies_LibItemAllowedRolesContainsEx
|
|
|
40
40
|
*/
|
|
41
41
|
export type Tests_Lib_Item_AllowedRolesAndPolicies_LibItemAllowedRolesHasNoDuplicates_Unique = Set<string>;
|
|
42
42
|
|
|
43
|
+
/**
|
|
44
|
+
* Tests - Lib - Item - Allowed Roles And Policies - Template Role Accepts Freezable.
|
|
45
|
+
*
|
|
46
|
+
* @since 0.23.0
|
|
47
|
+
*/
|
|
48
|
+
export type Tests_Lib_Item_AllowedRolesAndPolicies_TemplateRoleAcceptsFreezable_HasFreezable = boolean;
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Tests - Lib - Item - Allowed Roles And Policies - Template Role Accepts Trackable.
|
|
52
|
+
*
|
|
53
|
+
* @since 0.23.0
|
|
54
|
+
*/
|
|
55
|
+
export type Tests_Lib_Item_AllowedRolesAndPolicies_TemplateRoleAcceptsTrackable_HasTrackable = boolean;
|
|
56
|
+
|
|
43
57
|
/**
|
|
44
58
|
* Tests - Lib - Item - Changelog Constants - libItemChangelogAdjectives Has No Duplicates.
|
|
45
59
|
*
|
package/build/templates/generators/must-haves/agent-conventions/conventions/documentation.md
CHANGED
|
@@ -87,13 +87,15 @@ The right reader should feel informed; the wrong reader should not feel talked d
|
|
|
87
87
|
|
|
88
88
|
## Frontmatter
|
|
89
89
|
|
|
90
|
-
|
|
90
|
+
### Documentation Pages
|
|
91
|
+
|
|
92
|
+
Every documentation page requires these fields:
|
|
91
93
|
|
|
92
94
|
- `id` — kebab-case, matches filename without extension. No prefixes. For `index.mdx` files that serve as a category landing page, use a descriptive id that reflects the page's purpose (e.g., `overview`) instead of `index`.
|
|
93
|
-
- `title` — Title Case,
|
|
94
|
-
- `description` — One sentence,
|
|
95
|
-
- `keywords` —
|
|
96
|
-
- `tags` —
|
|
95
|
+
- `title` — Title Case, 1-5 words. Unique enough to distinguish pages in a sidebar. No trailing periods.
|
|
96
|
+
- `description` — One sentence, 120-160 characters. Starts with a verb or the feature name (never "This page explains...", "Learn how to...", or "Discover how...").
|
|
97
|
+
- `keywords` — 3-8 terms. Project name first, then feature name, category, and synonyms. Serves Docusaurus local search only (Google has not used meta keywords for ranking since 2009). Do not repeat the same word in different forms (e.g., "lint" and "linting").
|
|
98
|
+
- `tags` — 1-5 terms. First tag is the category (cli, rules, toolkit, quickstart). Optimized for Docusaurus local search, not external SEO.
|
|
97
99
|
|
|
98
100
|
```yaml
|
|
99
101
|
---
|
|
@@ -115,11 +117,20 @@ tags:
|
|
|
115
117
|
---
|
|
116
118
|
```
|
|
117
119
|
|
|
120
|
+
### Blog Posts
|
|
121
|
+
|
|
122
|
+
Blog post frontmatter follows the same field set with adjusted ranges for headlines and social sharing:
|
|
123
|
+
|
|
124
|
+
- `title` — Title Case, no word limit. Target under 60 characters for search engine display; subtitles after a colon are acceptable.
|
|
125
|
+
- `description` — One sentence, 120-160 characters. Core message in the first 120 characters (mobile search results truncate there).
|
|
126
|
+
- `keywords` — 3-8 terms.
|
|
127
|
+
- `tags` — 1-5 terms.
|
|
128
|
+
|
|
118
129
|
## SEO
|
|
119
130
|
|
|
120
|
-
- `description` reads as a natural sentence that a search engine would display as a snippet.
|
|
121
|
-
- Start with a verb or the feature name, never "This page explains..."
|
|
122
|
-
- `keywords`
|
|
131
|
+
- `description` reads as a natural sentence that a search engine would display as a snippet. Write the core message in the first 120 characters for mobile display; use up to 160 for desktop completeness.
|
|
132
|
+
- Start with a verb or the feature name, never "This page explains...", "Learn how to...", or "Discover how..."
|
|
133
|
+
- `keywords` serve Docusaurus local search only. Google has not used the meta keywords tag for ranking since 2009; Bing treats keyword-stuffed meta keywords as a spam signal.
|
|
123
134
|
- `tags` are optimized for Docusaurus local search, not external SEO.
|
|
124
135
|
|
|
125
136
|
## Page Templates
|
|
@@ -12,13 +12,13 @@
|
|
|
12
12
|
"test": "vitest run"
|
|
13
13
|
},
|
|
14
14
|
"dependencies": {
|
|
15
|
-
"@cbnventures/docusaurus-preset-nova": "0.
|
|
15
|
+
"@cbnventures/docusaurus-preset-nova": "0.23.0",
|
|
16
16
|
"@docusaurus/core": "3.7.0",
|
|
17
17
|
"react": "19.1.0",
|
|
18
18
|
"react-dom": "19.1.0"
|
|
19
19
|
},
|
|
20
20
|
"devDependencies": {
|
|
21
|
-
"@cbnventures/nova": "0.
|
|
21
|
+
"@cbnventures/nova": "0.23.0",
|
|
22
22
|
"@docusaurus/types": "3.7.0",
|
|
23
23
|
"glob": "13.0.6",
|
|
24
24
|
"typescript": "5.8.3",
|