Skip to content

Commit cff7cc9

Browse files
authored
Removed docs package (#32)
1 parent 6d2351c commit cff7cc9

29 files changed

+10
-1023
lines changed

README.MD

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,18 @@ app.use("/panel", (_, res) => {
155155

156156
`trpc-ui` welcomes and encourages open source contributions. Please see our [contributing](./CONTRIBUTING.md) guide for information on how to develop locally.
157157

158+
## Comparisons
159+
160+
### trpc-openapi
161+
[trpc-openapi](https://github.com/trpc/trpc-openapi) is designed for producing a REST API for external consumption from your trpc routers, not quickly testing your backed. If you do not care about exposing your API outside of your application, the additional overhead required to use `trpc-openapi` is not worth the effort. `trpc-ui` can be used with `trpc-openapi`, but the two libraries serve different purposes.
162+
163+
### trpc-playground
164+
165+
[trpc-playground](https://github.com/sachinraja/trpc-playground) is a great tool for testing your queries, but it requires writing code in the browser. `trpc-ui` automatically generates intuitive typesafe forms for your procedures, allowing you to run tests without writing any code.
166+
158167
## Limitations
159168

160-
Currently, tRPC panel only works with zod input schemas. With it's current design it would be feasible to easily add support for other input types as well
169+
Currently, tRPC panel only works with zod input schemas. There is no current plan to support other input validators, as zod remains the most popular choice for tRPC developers, and however if you would like to see support for another input validator, feel free to open an issue, and look into how we could reduce the amount of validator specific code that needs to be maintained by using something like [standard-schema](https://github.com/standard-schema/standard-schema).
161170

162171
### Supported zod types
163172

package.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,8 @@
88
"build:test-app": "yarn && npx nx build --project test-trpc-panel",
99
"dev:dev-app": "yarn workspace dev-app dev",
1010
"dev:test-app": "yarn workspace test-trpc-panel dev",
11-
"build:docs": "yarn && npx nx build --project docs",
1211
"cpy:readme": "cp README.MD packages/trpc-ui/README.md",
1312
"start:test-app": "node ./packages/test-app/lib/server.ts",
14-
"start:docs": "cd packages/docs && yarn serve",
1513
"biome:check": "biome check --max-diagnostics=none",
1614
"biome:check:changed": "biome check --changed --max-diagnostics=none",
1715
"biome:check:fix": "biome check --write --unsafe --max-diagnostics=none"

packages/docs/.gitignore

Lines changed: 0 additions & 20 deletions
This file was deleted.

packages/docs/README.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

packages/docs/babel.config.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

packages/docs/blog/authors.yml

Lines changed: 0 additions & 4 deletions
This file was deleted.
-152 KB
Binary file not shown.

packages/docs/docs/comparisons/openapi.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

packages/docs/docs/comparisons/playground.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

packages/docs/docs/compatibility-limitations.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)