Document more OpenAI-compatible providers in the README

Open Beginner friendly
#7 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript, markdown, nodejs, ollama, threejs
Domain
documentation

Research direction

The base URL table lives in the README, so start there and read the existing rows for Ollama, LM Studio, OpenRouter and Groq to match their format. Add rows only for providers you have tested, giving the base URL, a working model name and whether send page images is supported. Done means the table has new rows with each value confirmed by a real request, and the PR says which providers were tested.

Written by the indexing model from the issue text.

Description

documentation good first issue help wanted
What problem would this solve?

The README lists base URLs for Ollama, LM Studio, OpenRouter and Groq. Many people use other servers (for example DeepSeek, Mistral, Together, vLLM) and don't know what to type in the Base URL box.

What would you like to happen?

Add rows to the base URL table in the README for providers you have actually tried. For each one: the base URL, an example model name that works, and whether it accepts page images (send page images). Only add what you tested, and mention it in your PR. Docs only, no code needed.

Alternatives you've considered

No response

Contribution
  • I'd like to work on this myself
Dominant language
JavaScript
Stars
8
Forks
1
Avg merge
17m
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AlphaaCode/Popbook

All issues in AlphaaCode/Popbook

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.