Skip to content

Commit 712a31a

Browse files
committed
feat: Update documentation and assets for FoldCMS
- Refactor "Getting Started" section in the navigation to include a sub-item "What is FoldCMS?". - Add FoldCMS logo asset for use in documentation. - Update links in documentation to point to the latest commit in the core CMS code. - Remove outdated example reference page. - Update index page to use the new FoldCMS logo.
1 parent a579674 commit 712a31a

27 files changed

Lines changed: 55 additions & 61 deletions

apps/doc/astro.config.mjs

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,19 @@ export default defineConfig({
4646
label: "Guides",
4747
items: [
4848
// Each item here is one entry in the navigation menu.
49-
{ label: "Getting Started", slug: "guides/getting-started" },
49+
{
50+
label: "Getting Started",
51+
// slug: "guides/getting-started",
52+
items: [
53+
{
54+
label: "What is FoldCMS?",
55+
slug: "guides/getting-started",
56+
},
57+
],
58+
},
5059
],
5160
},
5261
typeDocSidebarGroup,
53-
{
54-
label: "Reference",
55-
autogenerate: { directory: "reference" },
56-
},
5762
],
5863
}),
5964
],
369 KB
Loading

apps/doc/src/content/docs/api/cms/classes/ContentStore.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ prev: false
55
title: "ContentStore"
66
---
77

8-
Defined in: [packages/core/src/cms.ts:805](https://github.com/bitswired/foldcms/blob/19c9e600da6c0170e8229bb7e1889de08e1cce6f/packages/core/src/cms.ts#L805)
8+
Defined in: [packages/core/src/cms.ts:805](https://github.com/bitswired/foldcms/blob/a5796744336f5646b8ccb4abf3c6d1334a83f443/packages/core/src/cms.ts#L805)
99

1010
Content storage abstraction providing CRUD operations for collections.
1111
Handles serialization, hashing, and database operations for content data.

apps/doc/src/content/docs/api/cms/classes/LoadingError.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ prev: false
55
title: "LoadingError"
66
---
77

8-
Defined in: [packages/core/src/cms.ts:30](https://github.com/bitswired/foldcms/blob/19c9e600da6c0170e8229bb7e1889de08e1cce6f/packages/core/src/cms.ts#L30)
8+
Defined in: [packages/core/src/cms.ts:30](https://github.com/bitswired/foldcms/blob/a5796744336f5646b8ccb4abf3c6d1334a83f443/packages/core/src/cms.ts#L30)
99

1010
Error thrown when data loading fails during collection processing.
1111

apps/doc/src/content/docs/api/cms/classes/TransformationError.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ prev: false
55
title: "TransformationError"
66
---
77

8-
Defined in: [packages/core/src/cms.ts:46](https://github.com/bitswired/foldcms/blob/19c9e600da6c0170e8229bb7e1889de08e1cce6f/packages/core/src/cms.ts#L46)
8+
Defined in: [packages/core/src/cms.ts:46](https://github.com/bitswired/foldcms/blob/a5796744336f5646b8ccb4abf3c6d1334a83f443/packages/core/src/cms.ts#L46)
99

1010
Error thrown when data transformation fails during collection processing.
1111

apps/doc/src/content/docs/api/cms/classes/ValidationError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ prev: false
55
title: "ValidationError"
66
---
77

8-
Defined in: [packages/core/src/cms.ts:65](https://github.com/bitswired/foldcms/blob/19c9e600da6c0170e8229bb7e1889de08e1cce6f/packages/core/src/cms.ts#L65)
8+
Defined in: [packages/core/src/cms.ts:65](https://github.com/bitswired/foldcms/blob/a5796744336f5646b8ccb4abf3c6d1334a83f443/packages/core/src/cms.ts#L65)
99

1010
Error thrown when data validation fails during collection processing.
1111
Contains detailed information about validation issues.
@@ -131,7 +131,7 @@ The cause of the error.
131131

132132
> `readonly` **issues**: readonly `string`[]
133133
134-
Defined in: [packages/core/src/cms.ts:67](https://github.com/bitswired/foldcms/blob/19c9e600da6c0170e8229bb7e1889de08e1cce6f/packages/core/src/cms.ts#L67)
134+
Defined in: [packages/core/src/cms.ts:67](https://github.com/bitswired/foldcms/blob/a5796744336f5646b8ccb4abf3c6d1334a83f443/packages/core/src/cms.ts#L67)
135135

136136
#### Inherited from
137137

apps/doc/src/content/docs/api/cms/functions/build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: "build"
77

88
> **build**\<`TMap`, `TCollection`\>(`config`): `Effect`\<`void`, [`LoadingError`](/api/cms/classes/loadingerror/) \| [`TransformationError`](/api/cms/classes/transformationerror/) \| [`ValidationError`](/api/cms/classes/validationerror/) \| `ContentStoreError`, [`ContentStore`](/api/cms/classes/contentstore/) \| \{ \[K in string \| number \| symbol\]: CollectionParts\<TCollection\[K\]\>\["loaderDeps"\] \| CollectionParts\<TCollection\[K\]\>\["transformerDeps"\] \| CollectionParts\<TCollection\[K\]\>\["validatorDeps"\] \}\[keyof `TCollection`\]\>
99
10-
Defined in: [packages/core/src/cms.ts:487](https://github.com/bitswired/foldcms/blob/19c9e600da6c0170e8229bb7e1889de08e1cce6f/packages/core/src/cms.ts#L487)
10+
Defined in: [packages/core/src/cms.ts:487](https://github.com/bitswired/foldcms/blob/a5796744336f5646b8ccb4abf3c6d1334a83f443/packages/core/src/cms.ts#L487)
1111

1212
Builds and initializes all collections in the CMS.
1313
This function loads, transforms, validates, and stores all collection data.

apps/doc/src/content/docs/api/cms/functions/defineCollection.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: "defineCollection"
99

1010
> **defineCollection**\<`TLoadSchema`, `TRelations`, `TLoaderDeps`, `TValidatorDeps`\>(`config`): [`Collection`](/api/cms/interfaces/collection/)\<`TLoadSchema`, `TLoadSchema`, `TRelations`, `TLoaderDeps`, `never`, `TValidatorDeps`\>
1111
12-
Defined in: [packages/core/src/cms.ts:193](https://github.com/bitswired/foldcms/blob/19c9e600da6c0170e8229bb7e1889de08e1cce6f/packages/core/src/cms.ts#L193)
12+
Defined in: [packages/core/src/cms.ts:193](https://github.com/bitswired/foldcms/blob/a5796744336f5646b8ccb4abf3c6d1334a83f443/packages/core/src/cms.ts#L193)
1313

1414
Factory function to define collections with type-safe configurations.
1515
Provides overloads for different collection configurations.
@@ -94,7 +94,7 @@ const posts = defineCollection({
9494

9595
> **defineCollection**\<`TLoadSchema`, `TRelations`, `TLoaderDeps`, `TTransformerDeps`, `TValidatorDeps`\>(`config`): [`Collection`](/api/cms/interfaces/collection/)\<`TLoadSchema`, `TLoadSchema`, `TRelations`, `TLoaderDeps`, `TTransformerDeps`, `TValidatorDeps`\>
9696
97-
Defined in: [packages/core/src/cms.ts:223](https://github.com/bitswired/foldcms/blob/19c9e600da6c0170e8229bb7e1889de08e1cce6f/packages/core/src/cms.ts#L223)
97+
Defined in: [packages/core/src/cms.ts:223](https://github.com/bitswired/foldcms/blob/a5796744336f5646b8ccb4abf3c6d1334a83f443/packages/core/src/cms.ts#L223)
9898

9999
Factory function to define collections with type-safe configurations.
100100
Provides overloads for different collection configurations.
@@ -183,7 +183,7 @@ const posts = defineCollection({
183183

184184
> **defineCollection**\<`TLoadSchema`, `TTransformSchema`, `TRelations`, `TLoaderDeps`, `TTransformerDeps`, `TValidatorDeps`\>(`config`): [`Collection`](/api/cms/interfaces/collection/)\<`TLoadSchema`, `TTransformSchema`, `TRelations`, `TLoaderDeps`, `TTransformerDeps`, `TValidatorDeps`\>
185185
186-
Defined in: [packages/core/src/cms.ts:260](https://github.com/bitswired/foldcms/blob/19c9e600da6c0170e8229bb7e1889de08e1cce6f/packages/core/src/cms.ts#L260)
186+
Defined in: [packages/core/src/cms.ts:260](https://github.com/bitswired/foldcms/blob/a5796744336f5646b8ccb4abf3c6d1334a83f443/packages/core/src/cms.ts#L260)
187187

188188
Factory function to define collections with type-safe configurations.
189189
Provides overloads for different collection configurations.

apps/doc/src/content/docs/api/cms/functions/factory.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: "factory"
77

88
> **factory**\<`TMap`, `TCollection`\>(): `Tag`\<[`Cms`](/api/cms/interfaces/cms/)\<`TMap`, `TCollection`, `CmsError` \| `ContentStoreError`\>, [`Cms`](/api/cms/interfaces/cms/)\<`TMap`, `TCollection`, `CmsError` \| `ContentStoreError`\>\>
99
10-
Defined in: [packages/core/src/cms.ts:554](https://github.com/bitswired/foldcms/blob/19c9e600da6c0170e8229bb7e1889de08e1cce6f/packages/core/src/cms.ts#L554)
10+
Defined in: [packages/core/src/cms.ts:554](https://github.com/bitswired/foldcms/blob/a5796744336f5646b8ccb4abf3c6d1334a83f443/packages/core/src/cms.ts#L554)
1111

1212
Factory function that creates a Context.Tag for a CMS instance.
1313
This tag is used to identify and inject CMS instances in the Effect context.

apps/doc/src/content/docs/api/cms/functions/makeCms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: "makeCms"
77

88
> **makeCms**\<`TMap`, `TCollection`\>(`config`): `object`
99
10-
Defined in: [packages/core/src/cms.ts:585](https://github.com/bitswired/foldcms/blob/19c9e600da6c0170e8229bb7e1889de08e1cce6f/packages/core/src/cms.ts#L585)
10+
Defined in: [packages/core/src/cms.ts:585](https://github.com/bitswired/foldcms/blob/a5796744336f5646b8ccb4abf3c6d1334a83f443/packages/core/src/cms.ts#L585)
1111

1212
Creates a CMS instance with its associated Context.Tag and Layer.
1313
This is the main factory function for creating a complete CMS setup.

0 commit comments

Comments
 (0)