Skip to content

Commit

Permalink
Small documentation messaging improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
captbaritone committed Mar 20, 2024
1 parent d25a4b8 commit 055d3f1
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 6 deletions.
4 changes: 2 additions & 2 deletions website/docs/01-getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

**What if building a GraphQL server were as simple as just writing functions?**
**What if buildng a GraphQL server were as simple as adding annotations to your TypeScript code?**

When you write your GraphQL server in TypeScript, your fields and resolvers are _already_ annotated with type information. _Grats leverages your existing type annotations to automatically extract an executable GraphQL schema from your generic TypeScript resolver code._
When you write your GraphQL server in TypeScript, your fields and resolvers are _already_ annotated with type information. _Grats leverages your existing type annotations to extract an executable GraphQL schema from your generic TypeScript resolver code._

By making your TypeScript implementation and its types the source of truth, you never have to worry about validating that your implementation matches your schema. Your implementation _is_ your schema!

Expand Down
17 changes: 14 additions & 3 deletions website/src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import HomepageExample from "!!raw-loader!./snippets/homepageExample.out";
import HomepageExampleFP from "!!raw-loader!./snippets/homepageExampleFP.out";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Link from "@docusaurus/Link";

export default function HomepageFeatures(): JSX.Element {
return (
Expand All @@ -13,8 +14,7 @@ export default function HomepageFeatures(): JSX.Element {
<div className="row">
<div className="col col--8 col--offset-2">
<h2 className="text--center margin-bottom--xl">
What if building a GraphQL server were as simple as just writing
functions?
The simplest way to build a GraphQL server in TypeScript
</h2>
</div>
</div>
Expand Down Expand Up @@ -42,7 +42,6 @@ export default function HomepageFeatures(): JSX.Element {
docblock hints. No Grats code is needed at runtime.
</p>
</div>

<div className="col col--8 margin-top--xl margin-bottom--xl col--offset-2">
<Tabs>
<TabItem value="oop" label="Object Oriented">
Expand All @@ -54,6 +53,18 @@ export default function HomepageFeatures(): JSX.Element {
</Tabs>
</div>
</div>
<div className="row">
<div className="col col--10 text--right margin-bottom--xl">
<div className={styles.buttons}>
<Link
className="button button--primary button--lg"
href="https://jordaneldredge.com/blog/grats/"
>
Read the Blog Post ➔
</Link>
</div>
</div>
</div>
</div>
</section>
);
Expand Down
2 changes: 1 addition & 1 deletion website/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ function HomepageHeader() {
className="button button--secondary button--lg"
to="/docs/getting-started/quick-start"
>
Quickstart
Quick Start
</Link>
</div>
<div className={styles.buttons}>
Expand Down

0 comments on commit 055d3f1

Please sign in to comment.