Skip to content

Commit

Permalink
docs: Update docs and example imports
Browse files Browse the repository at this point in the history
  • Loading branch information
tonyxiao committed Dec 4, 2023
1 parent 826ecbe commit 10931d6
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 15 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,37 +109,34 @@ Instead of navigating through thousands of lines of code across multiple files,
In traditional settings, each API client behaves uniquely, requiring developers to learn the nuances of every specific SDK. However, with OpenSDKs, there's a unifying similarity in how all APIs behave. This consistency significantly reduces the learning curve, making it easier for developers to transition between different APIs without the need to relearn or adjust to a new environment.



## Getting Started

Visit <a aria-label="opensdks learn" href="https://docs.opensdks.org/quickstart">https://docs.opensdks.org/quickstart</a> to get started with OpenSDKs.
Visit <a aria-label="opensdks learn" href="https://docs.opensdks.org/quickstart">https://docs.opensdks.org/quickstart</a> to get started with OpenSDKs.

## Documentation

Visit [https://docs.opensdks.org/introduction](https://docs.opensdks.org/introduction) to view the full documentation.

## Examples

Check out the example "summarize GitHub PR with OpenAI" app under [`examples/sum-pr`](https://github.com/useVenice/openSDKs/tree/main/examples/sum-pr). Demo link is here [https://what-did-we-work-on.vercel.app//](https://what-did-we-work-on.vercel.app//).


https://github.com/useVenice/openSDKs/blob/a3281e910c489fbeb7c70787a3fe6da5ca5f525f/examples/example.ts#L1-L128

https://github.com/useVenice/openSDKs/blob/a3281e910c489fbeb7c70787a3fe6da5ca5f525f/examples/summarize-pr.ts#L1-L54

For a full app example, check out the [`What did we work on app`](https://github.com/dosu-ai/what-did-we-work-on/). Demo link is here [https://what-did-we-work-on.vercel.app//](https://what-did-we-work-on.vercel.app//).

## Community

The OpenSDKs roadmap can be found on [GitHub Projects](https://github.com/orgs/useVenice/projects/2).
The OpenSDKs roadmap can be found on [GitHub Projects](https://github.com/orgs/useVenice/projects/2).

To chat with other community members you can join the [OpenSDKs Discord](https://discord.gg/6VNXagtqZK).

[Twitter](https://twitter.com/openSDKs)

## Contributing
## Add a missing SDK

To contribute new SDKs to the OpenSDKs suite, you can follow the [`CONTRIBUTING.md`](https://github.com/useVenice/openSDKs/blob/main/CONTRIBUTING.md).
To contribute new SDKs to the OpenSDKs suite, you can follow the [`CONTRIBUTING.md`](https://github.com/useVenice/openSDKs/blob/main/CONTRIBUTING.md).

## Contributors

<img src="https://contributors-img.web.app/image?repo=usevenice/openSDKs"/>
<img src="https://contributors-img.web.app/image?repo=useVenice/openSDKs"/>
11 changes: 5 additions & 6 deletions bin/updateExampleImports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@ const sdkList = fs
withFileTypes: true,
})
.filter((r) => r.isDirectory())
.map((d) => {
const path = pathJoin(__dirname, '../sdks', d.name)
.map((d) => pathJoin(__dirname, '../sdks', d.name, 'package.json'))
.filter((p) => fs.existsSync(p))
.map((p) => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const pkgJson: {name: string} = JSON.parse(
fs.readFileSync(pathJoin(path, 'package.json'), 'utf-8'),
)
const pkgJson: {name: string} = JSON.parse(fs.readFileSync(p, 'utf-8'))
return pkgJson.name
})

Expand All @@ -32,7 +31,7 @@ async function updateDocImports() {
pathJoin(__dirname, '../examples/package.json'),
await prettier.format(JSON.stringify(pkgJson), {
...(require('../prettier.config') as {}),
parser: 'json',
filepath: 'package.json', // Sort imports will apply, better than just parser: json
}),
)
}
Expand Down
1 change: 1 addition & 0 deletions examples/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"@opensdks/sdk-plaid": "workspace:*",
"@opensdks/sdk-slack": "workspace:*",
"@opensdks/sdk-twilio_api_v2010": "workspace:*",
"@opensdks/sdk-twilio_messaging_v1": "workspace:*",
"@opensdks/sdk-venice": "workspace:*",
"twilio": "^4.19.3"
},
Expand Down

1 comment on commit 10931d6

@vercel
Copy link

@vercel vercel bot commented on 10931d6 Dec 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

opensdks – ./

opensdks.vercel.app
opensdks-git-main-venice.vercel.app
opensdks-venice.vercel.app
opensdks.org

Please sign in to comment.