forked from
standard.site/standard.site
Standard.site landing page built in Next.js
update lexicon descriptions
+24
-24
+24
-24
app/data/lexicon-overrides.ts
+24
-24
app/data/lexicon-overrides.ts
···
3
3
4
4
export const DESCRIPTION_OVERRIDES: Record<string, Record<string, string>> = {
5
5
'site.standard.publication': {
6
-
url: 'Required base publication URL (ex: https://standard.site).',
7
-
icon: 'Optional square image to identify the publication. Should be at least 256x256.',
8
-
name: 'Required name of the publication.',
9
-
description: 'Optional brief description of the publication.',
10
-
basicTheme: 'Optional simplified publication theme for tools and apps to easily implement when displaying content.',
11
-
preferences: 'Optional object containing platform specific preferences (with a few shared properties).',
6
+
url: 'Base publication url (ex: `https://standard.site`). The canonical document URL is formed by combining this value with the document `path`.',
7
+
icon: 'Square image to identify the publication. Should be at least 256x256.',
8
+
name: 'Name of the publication.',
9
+
description: 'Brief description of the publication.',
10
+
basicTheme: 'Simplified publication theme for tools and apps to utilize when displaying content.',
11
+
preferences: 'Object containing platform specific preferences (with a few shared properties).',
12
12
},
13
13
'site.standard.theme.basic': {
14
-
background: 'Required color used for content background.',
15
-
foreground: 'Required color used for content text.',
16
-
accent: 'Required color used for links and button backgrounds.',
17
-
accentForeground: 'Required color used for button text.',
14
+
background: 'Color used for content background.',
15
+
foreground: 'Color used for content text.',
16
+
accent: 'Color used for links and button backgrounds.',
17
+
accentForeground: 'Color used for button text.',
18
18
},
19
19
'site.standard.publication#preferences': {
20
-
showInDiscover: 'Optional boolean which decides whether the publication should appear in discovery feeds.',
20
+
showInDiscover: 'Boolean which decides whether the publication should appear in discovery feeds.',
21
21
},
22
22
'site.standard.document': {
23
-
site: 'Required URI for parent site or publication (https:// or at://). Use https:// for loose documents. Avoid trailing slashes.',
24
-
path: 'Optional path, combined with site or publication url value to construct a full url to the document. Prepend with a leading slash.',
25
-
title: 'Required title of the document.',
26
-
description: 'Optional brief description or expert of the document.',
27
-
coverImage: 'Optional image to use as the documents cover. Less than 1MB is size.',
28
-
content: 'Optional open union to construct content within the record. Can be extended with other lexicons to define any content format.',
29
-
textContent: 'Optional plaintext representation of the documents contents. Useful for search and other cases.',
30
-
bskyPostRef: 'Optional strong reference to a Bluesky post. Useful to keep track of comments off-platform.',
31
-
tags: 'Optional array of strings used to tag/categorize the document. Avoid prepending tags with hashtags ("#").',
32
-
publishedAt: 'Required timestamp of the documents publication.',
33
-
updatedAt: 'Optional timestamp of the documents last edit.',
23
+
site: 'Points to a publication record (`at://`) or a publication url (`https://`) for loose documents. Avoid trailing slashes.',
24
+
path: 'Combine with `site` or publication `url` to construct a canonical URL to the document. Prepend with a leading slash.',
25
+
title: 'Title of the document.',
26
+
description: 'A brief description or excerpt from the document.',
27
+
coverImage: 'Image to used for thumbnail or cover image. Less than 1MB is size.',
28
+
content: 'Open union used to define the record\'s content. Each entry must specify a `$type` and may be extended with other lexicons to support additional content formats.',
29
+
textContent: 'Plaintext representation of the documents contents. Should not contain markdown or other formatting.',
30
+
bskyPostRef: 'Strong reference to a Bluesky post. Useful to keep track of comments off-platform.',
31
+
tags: 'Array of strings used to tag or categorize the document. Avoid prepending tags with hashtags.',
32
+
publishedAt: 'Timestamp of the documents publish time.',
33
+
updatedAt: 'Timestamp of the documents last edit.',
34
34
},
35
35
}
36
36
···
40
40
defName: string | null,
41
41
propertyName: string
42
42
): string | undefined {
43
-
const key = defName && defName !== 'main' ? `${ lexiconId }#${ defName }` : lexiconId
43
+
const key = defName && defName !== 'main' ? `${lexiconId}#${defName}` : lexiconId
44
44
return DESCRIPTION_OVERRIDES[key]?.[propertyName]
45
45
}
46
46
···
83
83
lexiconId: string,
84
84
defName: string | null
85
85
): string[] | undefined {
86
-
const key = defName && defName !== 'main' ? `${ lexiconId }#${ defName }` : lexiconId
86
+
const key = defName && defName !== 'main' ? `${lexiconId}#${defName}` : lexiconId
87
87
return PROPERTY_ORDER[key]
88
88
}