Request for Documentation Enhancement

[bakikucukcakiroglu]

Thanks for the library, it is a great job. I will use it on a production level repo, hope you and the community continue to support it.

Can you please enhance the documentation? Readme is so basic and even the imports like openai-agents are wrong. I think a strong documentation is one of the key factors what make a developer choose a library.

Also you should promote the library more like, 'I created this starter library and inviting everyone to help me' in developer forum topics and GitHub issues, especially in the ones where a js port is asked. If community supports it, it may be the official open source community js port at some point. Now, even if I search for openai-agents-js in Google, this repo doesn't show up.

[yusuf-eren]

Thanks a lot for the kind words and for taking the time to share this feedback. I really appreciate it.

It’s been really exciting to see a small weekend project grow into something that people are considering for production use. You're absolutely right about the documentation. The current README is very minimal, and I’ll be working on improving it with clearer examples, correct imports, and setup instructions. I will add examples to README for each usage like the official documentation.

I haven’t done much to promote the library so far, but I’ll start being more active in developer forums and GitHub discussions where a JavaScript port is being asked for. It would be amazing if this could eventually become the official open-source community version for JavaScript. That’s definitely something to work toward.

I’m always open to suggestions and ideas, and again, I really appreciate the encouragement.

I will also check other issues and reply as soon as possible.

[theill]

Just want to give you a "thank you" as well. It's a great library so thanks for making it. I'm amazed it only has 48 stars as of now. I'm pretty sure a lot of people would find it useful.

[yusuf-eren]

Thanks a lot @theill , really nice of you to say. Glad you're finding it helpful.

[bakikucukcakiroglu]

The only problem is that this library should gain traction before any official release from openAI. They may not release a official version if there is a one trusted by community. Otherwise, it will gracefully die. when the official version is released. To achieve traction, my suggestions as a developer would be:

• It should be carefully explained that python SDK does nothing special but a bunch of boilerplate code for a more convenient creation of a multi-agent system. Otherwise, people will always think that a "non-official" solution is less trustable or less performant. I know that @yusuf-eren shared this library in developer forums and issues asking for js port but they didin't gain to much attention because it wasn't clearly understood that why this library trust-ably works.

• Asking coding influencers to share the library.

• SEO optimization to make the library listed in the first page on the browser for the keywords openai-agents-js, openai-agents-ts, openai-agents-node, openai agents sdk javascript port, openai agents sdk typescript port etc. The second term can also help here since backlinks from strong web sites would affect the SEO in a good manner. Right now this library is not listed in first 10 pages for the keywordopenai-agents-js github

• Quick actions:

  • Add releases and release notes
  • Add topics
    • 

[yusuf-eren]

Thank you so much for the detailed advice. I just added proper topics to the repo and will be tackling the other suggestions (release notes, SEO, clearer positioning) very soon

[bakikucukcakiroglu]

The increase in the star count shows that the enhancements, activity, and word of mouth started to work. Time to keep the momentum! All incomers first look at the readme. It shows the abilities of the library also it creates the first impression of how capable/professional the maintainers are. I would rewrite the readme in a way that it shows all the abilities of the library. It should also include links to examples. That way, all of the incomers will think that it is a serious library.

A quick action to take: Create labels for issues. (e.g. bug report, question, feature request)

Also the original documentation can also be cloned with a small effort. (For me, it seems like even an AI pipeline may clone it to some extent)

[yusuf-eren]

I’ve shared the project in a few subreddits to help with visibility and community adoption. A full README rewrite is on the way to better highlight the library’s capabilities and link to usage examples. I’ll also add proper issue labels as you mentioned.
I checked OpenAI's original documentation. They are using mkdocs and some extra CSS. I copied the exact same view of it and will publish it as soon as I add a structure to it(probably this week).

And thanks in advance if you’re planning to help with the README. That would be a huge help. I'm open to contributions from anyone, so feel free to jump in wherever you think you can add value.

[yusuf-eren]

• Topics ✅
• Release and Release Notes ✅
• Documentation Website ✅ (documentation is not fully covered, but will be there soon) https://yusuf-eren.github.io/openai-agents-js/

I don't know how to convince coding influencers but currently sending the library to the DX people at OpenAI. They may be interested and we can make some stuff together 😄