forked from
standard.site/standard.site
Standard.site landing page built in Next.js
Update lexicon documentation
+25
-28
+22
-22
app/data/lexicon-overrides.ts
+22
-22
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: 'Base publication URL (ex: https://standard.site)',
7
-
icon: 'Square image to identify the publication (at least 256x256)',
8
-
name: 'The name of the publication',
9
-
description: 'Brief description of the publication',
10
-
basicTheme: 'Simplified publication theme for tools or apps to easily implement',
11
-
preferences: 'Object containing platform specific preferences (with a few shared properties)',
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).',
12
12
},
13
13
'site.standard.theme.basic': {
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',
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.',
18
18
},
19
19
'site.standard.publication#preferences': {
20
-
showInDiscover: 'Whether this publication should appear in discovery feeds',
20
+
showInDiscover: 'Optional boolean which decides whether the publication should appear in discovery feeds.',
21
21
},
22
22
'site.standard.document': {
23
-
site: 'URI for parent site or publication (https:// or at://). Use https:// for loose documents and avoid trailing slashes',
24
-
path: 'Combine with site or publication url value to construct a full url to the document. Prepend with a leading slash',
25
-
title: 'The title of the document',
26
-
description: 'Brief description or expert from the document',
27
-
coverImage: 'Image to use as the documents cover',
28
-
content: 'Open union to construct content from blocks or other primitives',
29
-
textContent: 'A plaintext representation of the documents content',
30
-
bskyPostRef: 'Strong reference to a Bluesky post',
31
-
tags: 'Array of strings used to tag/categorize the document',
32
-
publishedAt: 'The timestamp of the documents publication',
33
-
updatedAt: 'The timestamp of the documents last edit',
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.',
34
34
},
35
35
}
36
36
+3
-6
app/data/lexicons/document.json
+3
-6
app/data/lexicons/document.json