Skip to content

Commit c8e752c

Browse files
authored
docs: fix broken links and comments (#219)
* Fix bad markdown * Fix docs.json
1 parent 200eaed commit c8e752c

2 files changed

Lines changed: 29 additions & 69 deletions

File tree

docs/cli/generate-rules.mdx

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -65,44 +65,6 @@ typesync generate-rules --definition <filePathOrPattern> --outFile <filePath> --
6565
The name of the parameter taken by each type validator.
6666
</ParamField>
6767

68-
{/\* <ParamField
69-
type="string"
70-
path="readonlyFieldValidatorNamePattern"
71-
default="isReadonlyFieldAffectedFor{modelName}"
72-
73-
> The pattern that specifies how the generated readonly field validators are named. The pattern must be a string that contains the `"{modelName}"` substring (this is a literal value).
74-
75-
Example values:
76-
77-
- `"isReadonlyFieldAffectedFor{modelName}"` -> produces validators like `isReadonlyFieldAffectedForUser`, `isReadonlyFieldAffectedForProject`, `isReadonlyFieldAffectedForAccount` etc.
78-
- `"affectsReadonlyFieldFor{modelName}"` -> produces validators like `affectsReadonlyFieldForUser`, `affectsReadonlyFieldForProject`, `affectsReadonlyFieldForAccount` etc.
79-
80-
</ParamField> */}
81-
82-
{/\* <ParamField
83-
type="string"
84-
path="readonlyFieldValidatorPrevDataParamName"
85-
default="prevData"
86-
87-
> The name of the first parameter taken by each readonly field validator
88-
> representing previous data. This parameter used when computing the diff
89-
> between next data and previous data to determine whether a readonly field has
90-
> been affected by a write.
91-
92-
</ParamField> */}
93-
94-
{/\* <ParamField
95-
type="string"
96-
path="readonlyFieldValidatorNextDataParamName"
97-
default="nextData"
98-
99-
> The name of the second parameter taken by each readonly field validator
100-
> representing next data. This parameter used when computing the diff between
101-
> next data and previous data to determine whether a readonly field has been
102-
> affected by a write.
103-
104-
</ParamField> */}
105-
10668
<IndentationOption />
10769
<DebugOption />
10870

docs/docs.json

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$schema": "https://mintlify.com/schema.json",
2+
"$schema": "https://mintlify.com/docs.json",
33
"theme": "mint",
44
"name": "typesync",
55
"favicon": "/favicon.svg",
@@ -14,36 +14,32 @@
1414
}
1515
},
1616
"logo": { "light": "images/logo-light.png", "dark": "images/logo-dark.png" },
17-
"topbarLinks": [
18-
{
19-
"type": "link",
20-
"name": "Discord",
21-
"url": "https://discord.gg/Hb2HW98DvF"
17+
"navbar": {
18+
"primary": {
19+
"type": "github",
20+
"href": "https://github.com/kafkas/typesync"
2221
}
23-
],
24-
"topbarCtaButton": {
25-
"type": "link",
26-
"name": "GitHub",
27-
"url": "https://github.com/kafkas/typesync"
2822
},
29-
"anchors": [
30-
{
31-
"name": "GitHub",
32-
"icon": "github",
33-
"url": "https://github.com/kafkas/typesync"
34-
},
35-
{
36-
"name": "Changelog",
37-
"icon": "list-tree",
38-
"url": "https://github.com/kafkas/typesync/blob/main/CHANGELOG.md"
39-
},
40-
{
41-
"name": "Support",
42-
"icon": "discord",
43-
"url": "https://discord.gg/Hb2HW98DvF"
44-
}
45-
],
4623
"navigation": {
24+
"global": {
25+
"anchors": [
26+
{
27+
"anchor": "GitHub",
28+
"icon": "github",
29+
"href": "https://github.com/kafkas/typesync"
30+
},
31+
{
32+
"anchor": "Changelog",
33+
"icon": "list-tree",
34+
"href": "https://github.com/kafkas/typesync/blob/main/CHANGELOG.md"
35+
},
36+
{
37+
"anchor": "Support",
38+
"icon": "discord",
39+
"href": "https://discord.gg/Hb2HW98DvF"
40+
}
41+
]
42+
},
4743
"groups": [
4844
{
4945
"group": "Overview",
@@ -67,8 +63,10 @@
6763
}
6864
]
6965
},
70-
"footerSocials": {
71-
"discord": "https://discord.gg/Hb2HW98DvF",
72-
"github": "https://github.com/kafkas/typesync"
66+
"footer": {
67+
"socials": {
68+
"discord": "https://discord.gg/Hb2HW98DvF",
69+
"github": "https://github.com/kafkas/typesync"
70+
}
7371
}
7472
}

0 commit comments

Comments
 (0)