Skip to content

Commit efcef8c

Browse files
committed
maybe fix
1 parent f007c0f commit efcef8c

File tree

3 files changed

+41
-40
lines changed

3 files changed

+41
-40
lines changed

docs/message_types/about.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,3 @@
1-
# about (profile update)
2-
About messages are used to add additional information to another message, much like attaching post-it notes to some book page. You're _attaching information about_ something. Most use cases of `about` messages are to add names, images and descriptions to a user profile.
3-
4-
> **Attention:** There is no central authority handling names on the Scuttleverse. Much like in the physical world where two people can have the exact same name so it is on Scuttlebutt.
5-
>
6-
> You can name other people as well, just like partners and friends do.
7-
8-
9-
## What does it look like?
10-
11-
~~~
12-
{
13-
"key": "%buRChtQMrk/WjZQsfsgsg17XHmSDnMMKfFEXv/bjL43lQ=.sha256",
14-
"value": {
15-
"previous": null,
16-
"sequence": 1,
17-
"author": "@G/zUdqlPsdgsgd8yXIfMjx1676ApAOghwgc=.ed25519",
18-
"timestamp": 1560287825423,
19-
"hash": "sha256",
20-
"content": {
21-
"type": "about",
22-
"about": "@G/zUdqlPMsdgsdg8yXIfMjx1676ApAOghwgc=.ed25519",
23-
"image": "&N3ectV2qM5gyH2Zrsdgsdgd+InCMkJBc/MaTbJ0=.sha256",
24-
"name": "Hilo",
25-
"description": "extrem klug"
26-
},
27-
"signature": "UMjf4aFsdgsgUY9zeDAqWdTZeymoQznicvfgATu0/kArvLnshqbkiG7ZIngXcnztMUc6SyI4GrDwkAA==.sig.ed25519"
28-
},
29-
"timestamp": 1560288248693,
30-
"rts": 1560287825423
31-
}
32-
~~~
33-
34-
The message above is adding a `name`, an `image` and a `description` to the user specified by the `about` field.
35-
36-
There is a lot more [information about `about` online](http://scuttlebot.io/docs/message-types/about.html).
37-
38-
391
# about (gathering)
402

413
`about` messages are very flexible. They are often used to add or alter metadata _about_ some other message. In Patchfox documentation, I use the jargon that this message is _overloaded_ and it's meaning depends on which message it is _abouting_ about.
@@ -89,3 +51,41 @@ Let's look at another case of `about` being used with _gatherings_:
8951
```
9052

9153
That message is marking a _feed_ (aka a user) as attending the _gathering_.
54+
55+
56+
# about (profile update)
57+
About messages are used to add additional information to another message, much like attaching post-it notes to some book page. You're _attaching information about_ something. Most use cases of `about` messages are to add names, images and descriptions to a user profile.
58+
59+
> **Attention:** There is no central authority handling names on the Scuttleverse. Much like in the physical world where two people can have the exact same name so it is on Scuttlebutt.
60+
>
61+
> You can name other people as well, just like partners and friends do.
62+
63+
64+
## What does it look like?
65+
66+
~~~
67+
{
68+
"key": "%buRChtQMrk/WjZQsfsgsg17XHmSDnMMKfFEXv/bjL43lQ=.sha256",
69+
"value": {
70+
"previous": null,
71+
"sequence": 1,
72+
"author": "@G/zUdqlPsdgsgd8yXIfMjx1676ApAOghwgc=.ed25519",
73+
"timestamp": 1560287825423,
74+
"hash": "sha256",
75+
"content": {
76+
"type": "about",
77+
"about": "@G/zUdqlPMsdgsdg8yXIfMjx1676ApAOghwgc=.ed25519",
78+
"image": "&N3ectV2qM5gyH2Zrsdgsdgd+InCMkJBc/MaTbJ0=.sha256",
79+
"name": "Hilo",
80+
"description": "extrem klug"
81+
},
82+
"signature": "UMjf4aFsdgsgUY9zeDAqWdTZeymoQznicvfgATu0/kArvLnshqbkiG7ZIngXcnztMUc6SyI4GrDwkAA==.sig.ed25519"
83+
},
84+
"timestamp": 1560288248693,
85+
"rts": 1560287825423
86+
}
87+
~~~
88+
89+
The message above is adding a `name`, an `image` and a `description` to the user specified by the `about` field.
90+
91+
There is a lot more [information about `about` online](http://scuttlebot.io/docs/message-types/about.html).

docs/packages/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ These are the packages that Patchfox is loading.
55

66
* [KoFiIntegration](/packages/KoFiIntegration/)
77
* [blog](/packages/blog/)
8-
* [books](/packages/books/)
9-
* [errorHandler](/packages/errorHandler/)
108
* [calendar](/packages/calendar/)
9+
* [books](/packages/books/)
1110
* [contacts](/packages/contacts/)
1211
* [githubIntegration](/packages/githubIntegration/)
12+
* [errorHandler](/packages/errorHandler/)
1313
* [globalMenu](/packages/globalMenu/)
1414
* [helpMenu](/packages/helpMenu/)
1515
* [hub](/packages/hub/)

scripts/copy-package-docs.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const main = async () => {
1111
const messageTypesDocumentationRootPath = "docs/message_types"
1212

1313
let release_notes = `docs/release_notes/${localVersion}.md`
14+
await fs.ensureDir("build")
1415
fs.copyFileSync(release_notes, `build/release-notes.md`)
1516

1617
let paths = await globby([

0 commit comments

Comments
 (0)