Skip to content

Commit 0626843

Browse files
matifalimatifali
committed
docs: move api and cli docs under reference
1 parent 6f9b1a3 commit 0626843

File tree

123 files changed

+838
-411
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+838
-411
lines changed

‎.gitattributes

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Generated files
22
coderd/apidoc/docs.go linguist-generated=true
3-
docs/api/*.md linguist-generated=true
4-
docs/cli/*.md linguist-generated=true
3+
docs/reference/api/*.md linguist-generated=true
4+
docs/reference/cli/*.md linguist-generated=true
55
coderd/apidoc/swagger.json linguist-generated=true
66
coderd/database/dump.sql linguist-generated=true
77
peerbroker/proto/*.go linguist-generated=true

‎.prettierrc.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ tabWidth: 2
99
overrides:
1010
- files:
1111
- README.md
12-
- docs/api/**/*.md
13-
- docs/cli/**/*.md
12+
- docs/reference/api/**/*.md
13+
- docs/reference/cli/**/*.md
1414
- docs/changelogs/*.md
1515
- .github/**/*.{yaml,yml,toml}
1616
- scripts/**/*.{yaml,yml,toml}

‎.vscode/settings.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,8 @@
196196
"**/*.gen.json": true,
197197
"**/testdata/*": true,
198198
"coderd/apidoc/**": true,
199-
"docs/api/*.md": true,
199+
"docs/reference/api/*.md": true,
200+
"docs/reference/cli/*.md": true,
200201
"docs/templates/*.md": true,
201202
"LICENSE": true,
202203
"scripts/metricsdocgen/metrics": true,

‎Makefile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ gen: \
489489
codersdk/rbacresources_gen.go \
490490
site/src/api/rbacresources_gen.ts \
491491
docs/admin/prometheus.md \
492-
docs/cli.md \
492+
docs/reference/cli/README.md \
493493
docs/admin/audit-logs.md \
494494
coderd/apidoc/swagger.json \
495495
.prettierignore.include \
@@ -521,7 +521,7 @@ gen/mark-fresh:
521521
codersdk/rbacresources_gen.go \
522522
site/src/api/rbacresources_gen.ts \
523523
docs/admin/prometheus.md \
524-
docs/cli.md \
524+
docs/reference/cli/README.md \
525525
docs/admin/audit-logs.md \
526526
coderd/apidoc/swagger.json \
527527
.prettierignore.include \
@@ -633,10 +633,10 @@ docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/me
633633
./scripts/pnpm_install.sh
634634
pnpm exec prettier --write ./docs/admin/prometheus.md
635635

636-
docs/cli.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
636+
docs/reference/cli/README.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
637637
CI=true BASE_PATH="." go run ./scripts/clidocgen
638638
./scripts/pnpm_install.sh
639-
pnpm exec prettier --write ./docs/cli.md ./docs/cli/*.md ./docs/manifest.json
639+
pnpm exec prettier --write ./docs/reference/cli/README.md ./docs/reference/cli/*.md ./docs/manifest.json
640640

641641
docs/admin/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
642642
go run scripts/auditdocgen/main.go
@@ -646,7 +646,7 @@ docs/admin/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go
646646
coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen $(FIND_EXCLUSIONS) -type f) $(wildcard coderd/*.go) $(wildcard enterprise/coderd/*.go) $(wildcard codersdk/*.go) $(wildcard enterprise/wsproxy/wsproxysdk/*.go) $(DB_GEN_FILES) .swaggo docs/manifest.json coderd/rbac/object_gen.go
647647
./scripts/apidocgen/generate.sh
648648
./scripts/pnpm_install.sh
649-
pnpm exec prettier --write ./docs/api ./docs/manifest.json ./coderd/apidoc/swagger.json
649+
pnpm exec prettier --write ./docs/reference/api ./docs/manifest.json ./coderd/apidoc/swagger.json
650650

651651
update-golden-files: \
652652
cli/testdata/.gen-golden \

‎docs/manifest.json

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -546,99 +546,99 @@
546546
{
547547
"title": "API",
548548
"description": "Learn how to use Coderd API",
549-
"path": "./api/index.md",
549+
"path": "./reference/api/README.md",
550550
"icon_path": "./images/icons/api.svg",
551551
"children": [
552552
{
553553
"title": "General",
554-
"path": "./api/general.md"
554+
"path": "./reference/api/general.md"
555555
},
556556
{
557557
"title": "Agents",
558-
"path": "./api/agents.md"
558+
"path": "./reference/api/agents.md"
559559
},
560560
{
561561
"title": "Applications",
562-
"path": "./api/applications.md"
562+
"path": "./reference/api/applications.md"
563563
},
564564
{
565565
"title": "Audit",
566-
"path": "./api/audit.md"
566+
"path": "./reference/api/audit.md"
567567
},
568568
{
569569
"title": "Authentication",
570-
"path": "./api/authentication.md"
570+
"path": "./reference/api/authentication.md"
571571
},
572572
{
573573
"title": "Authorization",
574-
"path": "./api/authorization.md"
574+
"path": "./reference/api/authorization.md"
575575
},
576576
{
577577
"title": "Builds",
578-
"path": "./api/builds.md"
578+
"path": "./reference/api/builds.md"
579579
},
580580
{
581581
"title": "Debug",
582-
"path": "./api/debug.md"
582+
"path": "./reference/api/debug.md"
583583
},
584584
{
585585
"title": "Enterprise",
586-
"path": "./api/enterprise.md"
586+
"path": "./reference/api/enterprise.md"
587587
},
588588
{
589589
"title": "Files",
590-
"path": "./api/files.md"
590+
"path": "./reference/api/files.md"
591591
},
592592
{
593593
"title": "Git",
594-
"path": "./api/git.md"
594+
"path": "./reference/api/git.md"
595595
},
596596
{
597597
"title": "Insights",
598-
"path": "./api/insights.md"
598+
"path": "./reference/api/insights.md"
599599
},
600600
{
601601
"title": "Members",
602-
"path": "./api/members.md"
602+
"path": "./reference/api/members.md"
603603
},
604604
{
605605
"title": "Notifications",
606-
"path": "./api/notifications.md"
606+
"path": "./reference/api/notifications.md"
607607
},
608608
{
609609
"title": "Organizations",
610-
"path": "./api/organizations.md"
610+
"path": "./reference/api/organizations.md"
611611
},
612612
{
613613
"title": "PortSharing",
614-
"path": "./api/portsharing.md"
614+
"path": "./reference/api/portsharing.md"
615615
},
616616
{
617617
"title": "Schemas",
618-
"path": "./api/schemas.md"
618+
"path": "./reference/api/schemas.md"
619619
},
620620
{
621621
"title": "Templates",
622-
"path": "./api/templates.md"
622+
"path": "./reference/api/templates.md"
623623
},
624624
{
625625
"title": "Users",
626-
"path": "./api/users.md"
626+
"path": "./reference/api/users.md"
627627
},
628628
{
629629
"title": "WorkspaceProxies",
630-
"path": "./api/workspaceproxies.md"
630+
"path": "./reference/api/workspaceproxies.md"
631631
},
632632
{
633633
"title": "Workspaces",
634-
"path": "./api/workspaces.md"
634+
"path": "./reference/api/workspaces.md"
635635
}
636636
]
637637
},
638638
{
639639
"title": "Command Line",
640640
"description": "Learn how to use Coder CLI",
641-
"path": "./cli.md",
641+
"path": "./reference/README.md",
642642
"icon_path": "./images/icons/terminal.svg",
643643
"children": [
644644
{

‎docs/api/index.md renamed to ‎docs/reference/api/README.md

File renamed without changes.

‎docs/api/agents.md renamed to ‎docs/reference/api/agents.md

Lines changed: 32 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/applications.md renamed to ‎docs/reference/api/applications.md

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/audit.md renamed to ‎docs/reference/api/audit.md

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/authentication.md renamed to ‎docs/reference/api/authentication.md

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)