Skip to content

Commit

Permalink
Docs iteration (#736)
Browse files Browse the repository at this point in the history
* Add description to fern upgrade

* Sidebar iteration

* Change generator link references

* Add yarn add node-gyp

* Remove node-gyp to see if ete test passes
  • Loading branch information
dannysheridan authored Sep 20, 2022
1 parent 54ab679 commit 88edbb7
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 11 deletions.
2 changes: 1 addition & 1 deletion packages/docs/docs/cli/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ fern add postman

## Options

Here is [a list of code generators](../configuration/generators.md)) supported by Fern.
Here is [a list of code generators](../generators/supported.md) supported by Fern.
6 changes: 3 additions & 3 deletions packages/docs/docs/features/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: SDKs

## Languages supported

- [JavaScript/TypeScript](../configuration/generators.md#supported-generators)
- [Java](../configuration/generators.md#supported-generators)
- [Python](../configuration/generators.md#supported-generators)
- [JavaScript/TypeScript](../generators/supported.md#javascripttypescript)
- [Java](../generators/supported.md#java)
- [Python](../generators/supported.md#python)

## Request another language or framework

Expand Down
28 changes: 22 additions & 6 deletions packages/docs/docs/generators/supported.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,31 @@ Fern makes it easy to code generate SDKs, server interfaces, a Postman collectio

### Generate SDKs

- **fern-typescript**: a JavaScript SDK, fully typed with TypeScript declarations. Build Node.js, web, and mobile web applications.
- **fern-java**: A Java SDK.
- **fern-python**: A Python SDK. _(coming soon!)_
#### JavaScript/TypeScript

**fern-typescript**: A JavaScript SDK, fully typed with TypeScript declarations. Build Node.js, web, and mobile web applications.

#### Java

**fern-java**: A Java SDK.

#### Python

**fern-python**: A Python SDK. _(coming soon!)_

### Generate server interfaces

- **fern-typescript**: validation that your JavaScript or TypeScript Express server correctly implements your API.
- **fern-java**: validation that your Java Spring server correctly implements your API.
- **python-fastapi-server**: validation that your Python FastAPI server correctly implements your API. _(coming soon!)_
#### TypeScript Express

**fern-typescript**: Validation that your JavaScript or TypeScript Express server correctly implements your API.

#### Java Spring

**fern-java**: Validation that your Java Spring server correctly implements your API.

#### Python FastAPI

**fern-python**: Validation that your Python FastAPI server correctly implements your API. _(coming soon!)_

### Generate a Postman Collection

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ module.exports = {
{
type: "category",
label: "CLI",
items: [`cli/add`, `cli/check`, `cli/generate`, `cli/init`, `cli/upgrade`, `cli/fern.config.json`],
items: [`cli/add`, `cli/check`, `cli/generate`, `cli/init`, `cli/upgrade`, `cli/fern.config`],
},
{
type: "category",
Expand Down
2 changes: 2 additions & 0 deletions packages/docs/src/pages/index.module.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
/* stylelint-disable selector-class-pattern */

/**
* CSS files with the .module.css suffix will be treated as CSS modules
* and scoped locally.
Expand Down

0 comments on commit 88edbb7

Please sign in to comment.