Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): clean up comments and assets #5268

Merged
merged 2 commits into from
Nov 24, 2024
+30 −125
Merged

chore(docs): clean up comments and assets #5268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a8c0f9
chore(docs): clean up comments and assets
dannysheridan Nov 24, 2024
159b196
Merge branch 'main' into dsheridan/clean-up-assets
dannysheridan Nov 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 24 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<br/>
<div align="center">
<a href="https://www.buildwithfern.com/?utm_source=github&utm_medium=readme&utm_campaign=fern&utm_content=logo">
<img src="/fern/images/logo-primary.png" height="80" align="center" alt="header" />
<img src="/fern/images/logo-primary.svg" height="80" align="center" alt="header" />
</a>
<br/>

Expand All @@ -27,8 +27,6 @@ Fern is a toolkit that allows you to input your API Definition and output SDKs a
</a>
</div>



## 🌿 SDKs

The Fern toolkit is available via a command line interface (CLI) and requires Node 18+. To install it, run:
Expand Down Expand Up @@ -82,47 +80,46 @@ Postman Collections, Server boilerplate, etc.). To add a generator run `fern add

### SDK Generators

| Generator ID | Latest Version | Entrypoint |
| -------------------------------------- | -------------- | ------------------------------------------------------------------------------- |
| `fernapi/fern-typescript-node-sdk` | ![Typescript Generator Version](https://img.shields.io/docker/v/fernapi/fern-typescript-node-sdk) | [cli.ts](./generators/typescript/sdk/cli/src/nodeCli.ts) |
| `fernapi/fern-python-sdk` | ![Python Generator Version](https://img.shields.io/docker/v/fernapi/fern-python-sdk) | [cli.py](./generators/python/src/fern_python/generators/sdk/cli.py) |
| `fernapi/fern-java-sdk` | ![Java Generator Version](https://img.shields.io/docker/v/fernapi/fern-java-sdk) | [Cli.java](./generators/java/sdk/src/main/java/com/fern/java/client/Cli.java) |
| `fernapi/fern-ruby-sdk` | ![Ruby Generator Version](https://img.shields.io/docker/v/fernapi/fern-ruby-sdk) | [cli.ts](./generators/ruby/sdk/src/cli.ts) |
| `fernapi/fern-go-sdk` | ![Go Generator Version](https://img.shields.io/docker/v/fernapi/fern-go-sdk) | [main.go](./generators/go/cmd/fern-go-sdk/main.go) |
| `fernapi/fern-csharp-sdk` | ![C# Generator Version](https://img.shields.io/docker/v/fernapi/fern-csharp-sdk) | [cli.ts](./generators/csharp/sdk/src/cli.ts) |
| Generator ID | Latest Version | Entrypoint |
| ---------------------------------- | ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `fernapi/fern-typescript-node-sdk` | ![Typescript Generator Version](https://img.shields.io/docker/v/fernapi/fern-typescript-node-sdk) | [cli.ts](./generators/typescript/sdk/cli/src/nodeCli.ts) |
| `fernapi/fern-python-sdk` | ![Python Generator Version](https://img.shields.io/docker/v/fernapi/fern-python-sdk) | [cli.py](./generators/python/src/fern_python/generators/sdk/cli.py) |
| `fernapi/fern-java-sdk` | ![Java Generator Version](https://img.shields.io/docker/v/fernapi/fern-java-sdk) | [Cli.java](./generators/java/sdk/src/main/java/com/fern/java/client/Cli.java) |
| `fernapi/fern-ruby-sdk` | ![Ruby Generator Version](https://img.shields.io/docker/v/fernapi/fern-ruby-sdk) | [cli.ts](./generators/ruby/sdk/src/cli.ts) |
| `fernapi/fern-go-sdk` | ![Go Generator Version](https://img.shields.io/docker/v/fernapi/fern-go-sdk) | [main.go](./generators/go/cmd/fern-go-sdk/main.go) |
| `fernapi/fern-csharp-sdk` | ![C# Generator Version](https://img.shields.io/docker/v/fernapi/fern-csharp-sdk) | [cli.ts](./generators/csharp/sdk/src/cli.ts) |

### Server-side Generators

Fern's server-side generators output boilerplate application code (models and networking logic). This is intended for spec-first or API-first developers, who write their API definition (as an OpenAPI spec or Fern definition) and want to generate backend code.

| Generator ID | Latest Version | Entrypoint |
| ----------------------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------- |
| `fernapi/fern-typescript-express` | ![Typescript Express Server Generator Version](https://img.shields.io/docker/v/fernapi/fern-typescript-express) |[cli.ts](./generators/typescript/express/cli/src/cli.ts) |
| `fernapi/fern-fastapi-server` | ![Python FastAPI Server Generator Version](https://img.shields.io/docker/v/fernapi/fern-fastapi-server) | [cli.py](./generators/python/src/fern_python/generators/sdk/cli.py) |
| `fernapi/fern-java-spring` | ![Java Spring Server Generator Version](https://img.shields.io/docker/v/fernapi/fern-java-spring) | [Cli.java](./generators/java/spring/src/main/java/com/fern/java/spring/Cli.java) |
| Generator ID | Latest Version | Entrypoint |
| --------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `fernapi/fern-typescript-express` | ![Typescript Express Server Generator Version](https://img.shields.io/docker/v/fernapi/fern-typescript-express) | [cli.ts](./generators/typescript/express/cli/src/cli.ts) |
| `fernapi/fern-fastapi-server` | ![Python FastAPI Server Generator Version](https://img.shields.io/docker/v/fernapi/fern-fastapi-server) | [cli.py](./generators/python/src/fern_python/generators/sdk/cli.py) |
| `fernapi/fern-java-spring` | ![Java Spring Server Generator Version](https://img.shields.io/docker/v/fernapi/fern-java-spring) | [Cli.java](./generators/java/spring/src/main/java/com/fern/java/spring/Cli.java) |

### Model Generators

Fern's model generators will output schemas or types defined in your OpenAPI spec or Fern Definition.

| Generator ID | Latest Version | Entrypoint |
| ----------------------------- | --------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `fernapi/fern-pydantic-model` | ![Pydantic Model Generator Version](https://img.shields.io/docker/v/fernapi/fern-pydantic-model) | [cli.py](./generators/python/src/fern_python/generators/sdk/cli.py) |
| `fernapi/java-model` | ![Java Model Generator Version](https://img.shields.io/docker/v/fernapi/java-model) | [Cli.java](./generators/java/sdk/src/main/java/com/fern/java/client/Cli.java) |
| `fernapi/fern-ruby-model` | ![Ruby Model Generator Version](https://img.shields.io/docker/v/fernapi/fern-ruby-model) | [cli.ts](./generators/ruby/model/src/cli.ts) |
| `fernapi/fern-go-model` | ![Go Model Generator Version](https://img.shields.io/docker/v/fernapi/fern-go-model) | [main.go](./generators/go/cmd/fern-go-model/main.go) |
| Generator ID | Latest Version | Entrypoint |
| ----------------------------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------- |
| `fernapi/fern-pydantic-model` | ![Pydantic Model Generator Version](https://img.shields.io/docker/v/fernapi/fern-pydantic-model) | [cli.py](./generators/python/src/fern_python/generators/sdk/cli.py) |
| `fernapi/java-model` | ![Java Model Generator Version](https://img.shields.io/docker/v/fernapi/java-model) | [Cli.java](./generators/java/sdk/src/main/java/com/fern/java/client/Cli.java) |
| `fernapi/fern-ruby-model` | ![Ruby Model Generator Version](https://img.shields.io/docker/v/fernapi/fern-ruby-model) | [cli.ts](./generators/ruby/model/src/cli.ts) |
| `fernapi/fern-go-model` | ![Go Model Generator Version](https://img.shields.io/docker/v/fernapi/fern-go-model) | [main.go](./generators/go/cmd/fern-go-model/main.go) |

### Spec Generators

Fern's spec generators can output an OpenAPI spec or a Postman collection.

> **Note**: The OpenAPI spec generator is primarily intended for Fern Definition users. This prevents lock-in so that one can always export to OpenAPI.

| Generator ID | Latest Version | Entrypoint |
| ---------------------- | ------------------------------------------------- | ------------------------------------------ |
| `fernapi/fern-openapi` | ![OpenAPI Generator Version](https://img.shields.io/docker/v/fernapi/fern-openapi) | [cli.ts](./generators/openapi/src/cli.ts) |
| `fernapi/fern-postman` | ![Postman Generator Version](https://img.shields.io/docker/v/fernapi/fern-postman) | [cli.ts](./generators/postman/src/cli.ts) |

| Generator ID | Latest Version | Entrypoint |
| ---------------------- | ---------------------------------------------------------------------------------- | ----------------------------------------- |
| `fernapi/fern-openapi` | ![OpenAPI Generator Version](https://img.shields.io/docker/v/fernapi/fern-openapi) | [cli.ts](./generators/openapi/src/cli.ts) |
| `fernapi/fern-postman` | ![Postman Generator Version](https://img.shields.io/docker/v/fernapi/fern-postman) | [cli.ts](./generators/postman/src/cli.ts) |

## 🌿 CLI Commands

Expand Down
21 changes: 0 additions & 21 deletions fern/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ redirects:
- source: /learn/sdks/publish-sdk/publish-your-sdk
destination: /learn/sdks/guides/publish-your-sdk


navigation:
- tab: home
layout:
Expand All @@ -79,10 +78,6 @@ navigation:
- page: Authentication
icon: fa-regular fa-lock-keyhole
path: ./pages/api-definition/openapi/auth.mdx
# - page: OpenAPI Examples
# icon: fa-regular fa-square-terminal
# path: ./pages/api-definition/openapi/examples.mdx
# slug: examples
- section: Endpoints
icon: fa-regular fa-object-intersect
slug: endpoints
Expand Down Expand Up @@ -290,16 +285,6 @@ navigation:
- page: WebSockets
path: ./pages/sdks/capabilities/websockets.mdx
icon: fa-regular fa-pro
# icon: fa-regular fa-pro
# - page: Object oriented SDKs
# path: ./pages/sdks/capabilities/dummy.mdx
# icon: fa-regular fa-pro
# - page: Polling
# path: ./pages/sdks/capabilities/dummy.mdx
# icon: fa-regular fa-pro
# - page: GitHub integration
# path: ./pages/sdks/capabilities/dummy.mdx
# icon: fa-regular fa-pro
- section: Reference
contents:
- page: Configuration
Expand Down Expand Up @@ -407,7 +392,6 @@ navigation:
- section: Components
icon: fa-regular fa-toolbox
slug: components
# path: ./pages/docs/components/overview.mdx
contents:
- page: Overview
icon: fa-regular fa-wrench
Expand Down Expand Up @@ -570,9 +554,6 @@ navigation:
layout:
- page: Overview
path: ./pages/cli-api/api-summary.mdx
# snippets:
# python: fern-api
# typescript: "@fern-api/node-sdk"

navbar-links:
- type: minimal
Expand All @@ -596,8 +577,6 @@ logo:
light: ./images/logo-primary.svg
dark: ./images/logo-white.svg
height: 30
# background-image:
# dark: ./images/background.svg
colors:
accentPrimary:
dark: "#1DA32B"
Expand Down
71 changes: 0 additions & 71 deletions fern/images/background.svg
View file
Open in desktop

This file was deleted.

Binary file removed fern/images/logo-primary.png
View file
Open in desktop
Binary file not shown.
Binary file removed fern/images/logo-white.png
View file
Open in desktop
Binary file not shown.
4 changes: 2 additions & 2 deletions fern/pages/docs/getting-started/project-structure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ navbar-links:
url: https://buildwithfern.com/contact

logo:
light: ./images/logo-primary.png
dark: ./images/logo-white.png
light: ./images/logo-primary.svg
dark: ./images/logo-white.svg

colors:
accentPrimary:
Expand Down
2 changes: 1 addition & 1 deletion generators/go/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<br/>
<div align="center">
<a href="https://www.buildwithfern.com/?utm_source=github&utm_medium=readme&utm_campaign=fern-go&utm_content=logo">
<img src="../../fern/images/logo-primary.png" height="50" align="center" alt="header" />
<img src="../../fern/images/logo-primary.svg" height="50" align="center" alt="header" />
</a>

<br/>
Expand Down
2 changes: 1 addition & 1 deletion generators/openapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<br/>
<div align="center">
<a href="https://www.buildwithfern.com/?utm_source=github&utm_medium=readme&utm_campaign=fern-openapi&utm_content=logo">
<img src="/fern/images/logo-primary.png" height="50" align="center" alt="Fern logo" />
<img src="/fern/images/logo-primary.svg" height="50" align="center" alt="Fern logo" />
</a>

<br/>
Expand Down
2 changes: 1 addition & 1 deletion generators/postman/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<br/>
<div align="center">
<a href="https://www.buildwithfern.com/?utm_source=github&utm_medium=readme&utm_campaign=fern-postman&utm_content=logo">
<img src="/fern/images/logo-primary.png" height="50" align="center" alt="Fern logo" />
<img src="/fern/images/logo-primary.svg" height="50" align="center" alt="Fern logo" />
</a>

<br/>
Expand Down
Loading
Loading