sui-docs/sources.json at main · MystenLabs/sui-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
{
  "$comment": [
    "Every external source this repository renders, in one place.",
    "",
    "ownership tells you who edits a source and therefore how it behaves here:",
    "  moved    the pages live in this repo and are edited here.",
    "  mirrored the pages live in the source repo, are edited there, and are",
    "           committed here read-only by the mirror job. A pull request that",
    "           edits a mirrored path is forwarded to the source repo rather",
    "           than merged here. Their pages are not committed here; see .gitignore.",
    "",
    "ref pins what gets fetched. 'main' tracks the source's default branch;",
    "a tag or SHA freezes it. The three sources outside the MystenLabs org",
    "should be pinned to a SHA rather than a branch someone else controls.",
    "",
    "preserve lists files inside a mirrored target that are authored HERE and",
    "must survive the mirror's clean-and-rewrite. They are exempt from the guard."
  ],
  "sources": {
    "walrus": {
      "ownership": "mirrored",
      "repo": "MystenLabs/walrus",
      "ref": "main",
      "sourcePath": "docs/content",
      "targetPath": "content/walrus",
      "transforms": [
        "links"
      ],
      "linkPrefix": "/walrus",
      "preserve": [],
      "exclude": []
    },
    "suins": {
      "ownership": "mirrored",
      "repo": "MystenLabs/suins-contracts",
      "ref": "main",
      "sourcePath": "documentation/content",
      "targetPath": "content/suins",
      "transforms": [
        "links"
      ],
      "linkPrefix": "/suins",
      "preserve": [],
      "exclude": []
    },
    "hashi": {
      "ownership": "mirrored",
      "repo": "MystenLabs/hashi",
      "ref": "main",
      "sourcePath": "design/docs",
      "targetPath": "content/hashi",
      "transforms": [
        "links"
      ],
      "linkPrefix": "/hashi",
      "preserve": [],
      "exclude": []
    },
    "move-book": {
      "ownership": "mirrored",
      "repo": "MystenLabs/move-book",
      "ref": "main",
      "sourcePath": "book",
      "targetPath": "content/move-book",
      "transforms": [
        "links"
      ],
      "linkPrefix": "/move-book",
      "preserve": [],
      "exclude": []
    },
    "ts-sdks": {
      "ownership": "mirrored",
      "repo": "MystenLabs/ts-sdks",
      "ref": "main",
      "sourcePath": "packages/docs/content",
      "targetPath": "content/ts-sdks",
      "transforms": [],
      "linkPrefix": "/ts-sdks",
      "preserve": [],
      "exclude": [],
      "note": "Fumadocs MDX, not Docusaurus MDX. Mirrored for one searchable tree and one audit pipeline; its own site keeps building it."
    },
    "oyster": {
      "ownership": "mirrored",
      "repo": "MystenLabs/oyster",
      "ref": "main",
      "sourcePath": "docs/src",
      "targetPath": "content/oyster",
      "transforms": [
        "links"
      ],
      "linkPrefix": "/oyster",
      "preserve": [],
      "exclude": []
    },
    "walrus-memory": {
      "ownership": "mirrored",
      "repo": "MystenLabs/MemWal",
      "ref": "dev",
      "sourcePath": "docs",
      "targetPath": "content/walrus-memory",
      "transforms": [
        "links"
      ],
      "linkPrefix": "/walrus-memory",
      "preserve": [],
      "exclude": []
    }
  },
  "codeSources": {
    "$comment": "Fetched so pages can quote and verify source. Never written back, never rendered as pages. The ones outside MystenLabs are called out because nobody here controls their branches.",
    "sui": {
      "repo": "MystenLabs/sui",
      "ref": "main",
      "paths": [
        "crates",
        "examples",
        "release-notes"
      ]
    },
    "ts-sdks": {
      "repo": "MystenLabs/ts-sdks",
      "ref": "main",
      "paths": [
        "packages"
      ]
    },
    "deepbookv3": {
      "repo": "MystenLabs/deepbookv3",
      "ref": "main",
      "paths": [
        "packages"
      ]
    },
    "sui-apis": {
      "repo": "MystenLabs/sui-apis",
      "ref": "gen-docs",
      "paths": [
        "documentation.json"
      ]
    },
    "playtron-sdk": {
      "repo": "playtron-os/playtron-sdk",
      "ref": "main",
      "paths": [
        "."
      ],
      "external": true
    },
    "awesome-sui": {
      "repo": "sui-foundation/awesome-sui",
      "ref": "main",
      "paths": [
        "."
      ]
    },
    "awesome-sui-gaming": {
      "repo": "becky-sui/awesome-sui-gaming",
      "ref": "main",
      "paths": [
        "."
      ]
    }
  }
}