Skip to content

docs: add example apps links to README, overview, and sidebar #29

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

Merged
weedon-openai merged 2 commits into from
Oct 8, 2025
Merged

docs: add example apps links to README, overview, and sidebar #29

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
1325775
docs: add example apps links to README, overview, and sidebar
weedon-openai Oct 8, 2025
eb97781
Merge branch 'main' into docs/add-example-links
weedon-openai Oct 8, 2025
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,11 @@ Just add the ChatKit component, give it a client token, and customize the chat e
}
```

## See working examples

- [Starter app](https://github.com/openai/openai-chatkit-starter-app) - Clone a repo to start with a fully working template
- [Samples](https://github.com/openai/openai-chatkit-advanced-samples) - See working examples of ChatKit and get inspired

## License

This project is licensed under the [Apache License 2.0](LICENSE).
13 changes: 13 additions & 0 deletions packages/docs/astro.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,19 @@ const sidebar = [
},
],
},
{
label: 'Examples',
items: [
{
label: 'Starter App',
link: 'https://github.com/openai/openai-chatkit-starter-app',
},
{
label: 'Advanced Samples',
link: 'https://github.com/openai/openai-chatkit-advanced-samples',
},
],
},
];

export default defineConfig({
Expand Down
4 changes: 4 additions & 0 deletions packages/docs/src/content/docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,7 @@ You don’t need to build custom UIs, manage low-level chat state, or patch toge
Just add the ChatKit component, give it a client token, and customize the chat experience as needed, no extra work needed.


## See working examples

- [Starter app](https://github.com/openai/openai-chatkit-starter-app) - Clone a repo to start with a fully working template
- [Samples](https://github.com/openai/openai-chatkit-advanced-samples) - See working examples of ChatKit and get inspired