Docs: Consolidate About pages, Highlight Maintainers, Consolidate Contributors #2122
Conversation
|
✅ Deploy Preview for openapi-ts ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
9a7502f to
eb05e1f
Compare
size-limit report 📦
|
eb05e1f to
2a53972
Compare
| "freshgiammi", | ||
| "lukasedw", | ||
| "ViktorPontinen", | ||
| "kevmo314", |
There was a problem hiding this comment.
We were pretty behind on this list! We’ve far exceeded 100 contributors 🤩
2a53972 to
42e6836
Compare
| @@ -27,34 +28,49 @@ description: Additional info about this project | |||
| - [**Revolt**](https://github.com/revoltchat/api): open source user-first chat platform | |||
| - [**Spacebar**](https://github.com/spacebarchat): a free, open source, self-hostable Discord-compatible chat/voice/video platform | |||
| - [**Supabase**](https://github.com/supabase/supabase): The open source Firebase alternative. | |||
| - [**Twitter API**](https://github.com/twitterdev/twitter-api-typescript-sdk): Official SDK for the Twitter API | |||
| 1. Support converting any valid OpenAPI schema to TypeScript types, no matter how complicated. | ||
| 1. Generated types should be statically-analyzable and runtime-free (with minor exceptions like [enums](https://www.typescriptlang.org/docs/handbook/enums.html). | ||
| 1. Generated types should match your original schema as closely as possible, preserving original capitalization, etc. | ||
| 1. Typegen only needs Node.js to run (no Java, Python, etc.) and works in any environment. | ||
| 1. Support fetching OpenAPI schemas from files as well as local and remote servers. | ||
|
|
||
| ## Differences |
There was a problem hiding this comment.
Note: the differences are removed; I debate whether or not these are useful. If we think they are, they should probably go in the intro?
| }, | ||
| { text: "About", link: "/about" }, | ||
| { text: "useSuspenseQuery", link: "/use-suspense-query" }, | ||
| { text: "queryOptions", link: "/query-options" }, |
There was a problem hiding this comment.
I think we forgot to add use useInfiniteQuery here @drwpow
There was a problem hiding this comment.
Oh that’s a good callout thank you! I was running through the docs and noticed there are some formatting differences between all the packages—APIs are not only written differently but also split up across pages. I’ll make sure they’re in the sidebar in a PR that makes everything consistent.
My philosophy is first just write the docs, then worry about formatting and consistency later. Inconsistent docs are a great problem to have—it means a) they exist, and b) multiple people contributed to them, so the most important parts are done
|
|
||
| ### vs. tRPC | ||
| ## メインテナー |
There was a problem hiding this comment.
my barely-JLPT5 proficiency led me to make this guess for a new heading. I don’t feel confident trying to write entire sentences though (I would never run something through Google Translate)
Changes
Consolidates 4 About pages into one, creates a new “Maintainers” section, and consolidates Contributors into one big grid
How to Review
(See Netlify link)
Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)