diff --git a/README.md b/README.md index 5856f7e1b29..a7a6cf402f3 100644 --- a/README.md +++ b/README.md @@ -46,11 +46,19 @@ We are very very early in this project. Expect bugs. We are not accepting contributions yet. -Observability guide: [docs/observability.md](./docs/observability.md) +Observability guide: [docs/operations/observability.md](./docs/operations/observability.md) -Relay observability: [docs/relay-observability.md](./docs/relay-observability.md) +Relay observability: [docs/operations/relay-observability.md](./docs/operations/relay-observability.md) -T3 Cloud Clerk setup: [docs/t3-cloud-clerk.md](./docs/t3-cloud-clerk.md) +T3 Cloud Clerk setup: [docs/cloud/t3-cloud-clerk.md](./docs/cloud/t3-cloud-clerk.md) + +## Documentation + +- [Getting started](./docs/getting-started/quick-start.md) +- [Architecture overview](./docs/architecture/overview.md) +- [Provider guides](./docs/providers/codex.md) +- [Operations](./docs/operations/ci.md) +- [Reference](./docs/reference/encyclopedia.md) ## If you REALLY want to contribute still.... read this first diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000000..f1b7f94fd7e --- /dev/null +++ b/docs/README.md @@ -0,0 +1,11 @@ +# Documentation + +- [Getting started](./getting-started/quick-start.md) +- [Architecture](./architecture/overview.md) +- [Cloud](./cloud/t3-cloud-clerk.md) +- [Integrations](./integrations/source-control-providers.md) +- [Mobile](./mobile/app.md) +- [Operations](./operations/ci.md) +- [Providers](./providers/codex.md) +- [Reference](./reference/encyclopedia.md) +- [User guides](./user/keybindings.md) diff --git a/.docs/architecture.md b/docs/architecture/overview.md similarity index 100% rename from .docs/architecture.md rename to docs/architecture/overview.md diff --git a/.docs/provider-architecture.md b/docs/architecture/providers.md similarity index 100% rename from .docs/provider-architecture.md rename to docs/architecture/providers.md diff --git a/.docs/remote-architecture.md b/docs/architecture/remote.md similarity index 100% rename from .docs/remote-architecture.md rename to docs/architecture/remote.md diff --git a/.docs/runtime-modes.md b/docs/architecture/runtime-modes.md similarity index 100% rename from .docs/runtime-modes.md rename to docs/architecture/runtime-modes.md diff --git a/docs/environment-auth.md b/docs/cloud/environment-auth.md similarity index 100% rename from docs/environment-auth.md rename to docs/cloud/environment-auth.md diff --git a/docs/t3-cloud-clerk.md b/docs/cloud/t3-cloud-clerk.md similarity index 100% rename from docs/t3-cloud-clerk.md rename to docs/cloud/t3-cloud-clerk.md diff --git a/docs/t3-code-cloud-auth-flow.html b/docs/cloud/t3-code-cloud-auth-flow.html similarity index 100% rename from docs/t3-code-cloud-auth-flow.html rename to docs/cloud/t3-code-cloud-auth-flow.html diff --git a/.docs/codex-prerequisites.md b/docs/getting-started/codex-prerequisites.md similarity index 100% rename from .docs/codex-prerequisites.md rename to docs/getting-started/codex-prerequisites.md diff --git a/.docs/quick-start.md b/docs/getting-started/quick-start.md similarity index 100% rename from .docs/quick-start.md rename to docs/getting-started/quick-start.md diff --git a/docs/source-control-providers.md b/docs/integrations/source-control-providers.md similarity index 100% rename from docs/source-control-providers.md rename to docs/integrations/source-control-providers.md diff --git a/apps/mobile/README.md b/docs/mobile/app.md similarity index 100% rename from apps/mobile/README.md rename to docs/mobile/app.md diff --git a/apps/mobile/modules/t3-terminal/README.md b/docs/mobile/terminal-native-module.md similarity index 100% rename from apps/mobile/modules/t3-terminal/README.md rename to docs/mobile/terminal-native-module.md diff --git a/.docs/ci.md b/docs/operations/ci.md similarity index 86% rename from .docs/ci.md rename to docs/operations/ci.md index 71f1db4e91e..244446ba959 100644 --- a/.docs/ci.md +++ b/docs/operations/ci.md @@ -3,4 +3,4 @@ - `.github/workflows/ci.yml` runs `bun run lint`, `bun run typecheck`, and `bun run test` on pull requests and pushes to `main`. - `.github/workflows/release.yml` builds macOS (`arm64` and `x64`), Linux (`x64`), and Windows (`x64`) desktop artifacts from a single `v*.*.*` tag and publishes one GitHub release. - The release workflow auto-enables signing only when secrets are present: Apple credentials for macOS and Azure Trusted Signing credentials for Windows. Without secrets, it still releases unsigned artifacts. -- See `docs/release.md` for full release/signing setup checklist. +- See [Release Checklist](./release.md) for the full release/signing setup checklist. diff --git a/docs/effect-fn-checklist.md b/docs/operations/effect-fn-checklist.md similarity index 100% rename from docs/effect-fn-checklist.md rename to docs/operations/effect-fn-checklist.md diff --git a/docs/observability.md b/docs/operations/observability.md similarity index 100% rename from docs/observability.md rename to docs/operations/observability.md diff --git a/docs/relay-observability.md b/docs/operations/relay-observability.md similarity index 100% rename from docs/relay-observability.md rename to docs/operations/relay-observability.md diff --git a/docs/release.md b/docs/operations/release.md similarity index 100% rename from docs/release.md rename to docs/operations/release.md diff --git a/TODO.md b/docs/project/todo.md similarity index 100% rename from TODO.md rename to docs/project/todo.md diff --git a/.docs/encyclopedia.md b/docs/reference/encyclopedia.md similarity index 100% rename from .docs/encyclopedia.md rename to docs/reference/encyclopedia.md diff --git a/.docs/scripts.md b/docs/reference/scripts.md similarity index 100% rename from .docs/scripts.md rename to docs/reference/scripts.md diff --git a/.docs/workspace-layout.md b/docs/reference/workspace-layout.md similarity index 100% rename from .docs/workspace-layout.md rename to docs/reference/workspace-layout.md diff --git a/KEYBINDINGS.md b/docs/user/keybindings.md similarity index 95% rename from KEYBINDINGS.md rename to docs/user/keybindings.md index b57c13032ce..67652cc957d 100644 --- a/KEYBINDINGS.md +++ b/docs/user/keybindings.md @@ -13,7 +13,7 @@ The file must be a JSON array of rules: ] ``` -See the full schema for more details: [`packages/contracts/src/keybindings.ts`](packages/contracts/src/keybindings.ts) +See the full schema for more details: [`packages/contracts/src/keybindings.ts`](../../packages/contracts/src/keybindings.ts) ## Defaults @@ -31,7 +31,7 @@ See the full schema for more details: [`packages/contracts/src/keybindings.ts`]( ] ``` -For most up to date defaults, see [`DEFAULT_KEYBINDINGS` in `apps/server/src/keybindings.ts`](apps/server/src/keybindings.ts) +For most up to date defaults, see [`DEFAULT_KEYBINDINGS` in `apps/server/src/keybindings.ts`](../../apps/server/src/keybindings.ts) ## Configuration diff --git a/REMOTE.md b/docs/user/remote-access.md similarity index 100% rename from REMOTE.md rename to docs/user/remote-access.md