@ctcstack/ctcdocs-core 0.7.1 → 0.9.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.
Files changed (4) hide show
  1. package/dist/project-layout.d.ts +9 -1
  2. package/dist/project-layout.js +9 -0
  3. package/package.json +1 -1
  4. package/src/project-layout.ts +9 -0
package/dist/project-layout.d.ts CHANGED
@@ -30,6 +30,8 @@ export declare const PROJECT_LAYOUT: {
30
30
  readonly manifestFile: "data/sync-manifest.json";
31
31
  readonly documentIndexFile: "data/docs-index.json";
32
32
  readonly syncReportFile: "data/latest-sync-report.json";
33
+ /** What each document's opening says about its title (ADR-023). */
34
+ readonly titleReportFile: "data/title-report.json";
33
35
  };
34
36
  /**
35
37
  * Addresses the platform serves itself.
@@ -51,10 +53,16 @@ export declare const PLATFORM_ROUTES: {
51
53
  * docs/ADR/022-permanent-short-ids.md.
52
54
  */
53
55
  readonly permanentLinks: "d";
56
+ /**
57
+ * What editors have to fix, grouped by action. See
58
+ * docs/ADR/024-content-health-page.md.
59
+ */
60
+ readonly contentHealth: "content-health";
54
61
  };
55
62
  /** Each platform route as the href a link uses. */
56
63
  export declare const PLATFORM_ROUTE_HREFS: {
57
64
  readonly fullIndex: "/documents/";
65
+ readonly contentHealth: "/content-health/";
58
66
  };
59
67
  export declare const RESERVED_SLUGS: readonly string[];
60
68
  /**
@@ -66,4 +74,4 @@ export declare const SHORT_ID_PATTERN: RegExp;
66
74
  /** The site-relative permanent link of an item with this short ID. */
67
75
  export declare function permanentLinkPath(shortId: string): string;
68
76
  export declare const GENERATED_DIRECTORY_ALLOWLIST: readonly ["src/content/docs/_generated", "src/assets/generated", "src/generated"];
69
- export declare const GENERATED_FILE_ALLOWLIST: readonly ["data/sync-manifest.json", "data/docs-index.json", "data/latest-sync-report.json"];
77
+ export declare const GENERATED_FILE_ALLOWLIST: readonly ["data/sync-manifest.json", "data/docs-index.json", "data/latest-sync-report.json", "data/title-report.json"];
package/dist/project-layout.js CHANGED
@@ -30,6 +30,8 @@ export const PROJECT_LAYOUT = {
30
30
  manifestFile: 'data/sync-manifest.json',
31
31
  documentIndexFile: 'data/docs-index.json',
32
32
  syncReportFile: 'data/latest-sync-report.json',
33
+ /** What each document's opening says about its title (ADR-023). */
34
+ titleReportFile: 'data/title-report.json',
33
35
  };
34
36
  /**
35
37
  * Addresses the platform serves itself.
@@ -51,10 +53,16 @@ export const PLATFORM_ROUTES = {
51
53
  * docs/ADR/022-permanent-short-ids.md.
52
54
  */
53
55
  permanentLinks: 'd',
56
+ /**
57
+ * What editors have to fix, grouped by action. See
58
+ * docs/ADR/024-content-health-page.md.
59
+ */
60
+ contentHealth: 'content-health',
54
61
  };
55
62
  /** Each platform route as the href a link uses. */
56
63
  export const PLATFORM_ROUTE_HREFS = {
57
64
  fullIndex: `/${PLATFORM_ROUTES.fullIndex}/`,
65
+ contentHealth: `/${PLATFORM_ROUTES.contentHealth}/`,
58
66
  };
59
67
  export const RESERVED_SLUGS = Object.freeze(Object.values(PLATFORM_ROUTES));
60
68
  /**
@@ -76,4 +84,5 @@ export const GENERATED_FILE_ALLOWLIST = [
76
84
  PROJECT_LAYOUT.manifestFile,
77
85
  PROJECT_LAYOUT.documentIndexFile,
78
86
  PROJECT_LAYOUT.syncReportFile,
87
+ PROJECT_LAYOUT.titleReportFile,
79
88
  ];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ctcstack/ctcdocs-core",
3
- "version": "0.7.1",
3
+ "version": "0.9.0",
4
4
  "description": "Configuration schema, project layout, and generated-path allowlist shared by the CTCDocs platform packages.",
5
5
  "keywords": [
6
6
  "ctcdocs",
package/src/project-layout.ts CHANGED
@@ -30,6 +30,8 @@ export const PROJECT_LAYOUT = {
30
30
  manifestFile: 'data/sync-manifest.json',
31
31
  documentIndexFile: 'data/docs-index.json',
32
32
  syncReportFile: 'data/latest-sync-report.json',
33
+ /** What each document's opening says about its title (ADR-023). */
34
+ titleReportFile: 'data/title-report.json',
33
35
  } as const;
34
36
 
35
37
  /**
@@ -52,11 +54,17 @@ export const PLATFORM_ROUTES = {
52
54
  * docs/ADR/022-permanent-short-ids.md.
53
55
  */
54
56
  permanentLinks: 'd',
57
+ /**
58
+ * What editors have to fix, grouped by action. See
59
+ * docs/ADR/024-content-health-page.md.
60
+ */
61
+ contentHealth: 'content-health',
55
62
  } as const;
56
63
 
57
64
  /** Each platform route as the href a link uses. */
58
65
  export const PLATFORM_ROUTE_HREFS = {
59
66
  fullIndex: `/${PLATFORM_ROUTES.fullIndex}/`,
67
+ contentHealth: `/${PLATFORM_ROUTES.contentHealth}/`,
60
68
  } as const;
61
69
 
62
70
  export const RESERVED_SLUGS: readonly string[] = Object.freeze(
@@ -85,4 +93,5 @@ export const GENERATED_FILE_ALLOWLIST = [
85
93
  PROJECT_LAYOUT.manifestFile,
86
94
  PROJECT_LAYOUT.documentIndexFile,
87
95
  PROJECT_LAYOUT.syncReportFile,
96
+ PROJECT_LAYOUT.titleReportFile,
88
97
  ] as const;