Skip to content

Create provider docs for gpustack and xai #274

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.

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

Closed
bhouston opened this issue Mar 14, 2025 · 4 comments
Closed

Create provider docs for gpustack and xai #274

bhouston opened this issue Mar 14, 2025 · 4 comments

Comments

@bhouston
Copy link
Member

bhouston commented Mar 14, 2025

These are currently missing. xai and gpustack support have been added in this PR: #273. I also changed ollamaBaseUrl to just baseUrl because it can be used with most providers now. We will need to add xai and gpustack as providers in the documentation. We will have to update the docs to use the baseUrl instead of ollamaBaseUrl in the documentation.

The PR also changed the locations were mycoder.config.js is searched for. It now only searches in the current directory as well as the user's directory. It no longer walks up each directory looking for the first match.

Oops. I notice that the provider called gpustack says its documentation URL is https://mycoder.ai/docs/provider/local-openai. I think I was intending to call gpustack 'local-openai' and we should make that change in the provider list - it should be 'local-openai'. We can mention in the docs that it supports gpustack.

The urls in the code that point to expected docs are in the provider.ts file in the packages/agent code base. We should ensure that all of those exist.

If you are writing docs for a new provider, please reference the existing ones for ideas.

I also added to provider.ts default models for each provider and sometimes default baseUrls and the expected apiKey name (if a key is expected at all). Can you add those defaults to the docs for each provider if they are set?

@bhouston
Copy link
Member Author

/mycoder can you update the docs based on the instructions above?

@bhouston
Copy link
Member Author

I see that PR #279 has already been created to address this request. The PR includes:

  1. New documentation files for the requested providers:

    • local-openai.md (for gpustack and other OpenAI-compatible servers)
    • xai.md (for Grok models from xAI)
  2. Updates to references from ollamaBaseUrl to baseUrl in:

    • Ollama provider documentation
    • README.md
  3. Updates to the providers index.mdx to include the new providers

  4. Documentation for default models, baseUrls, and apiKey information for each provider

The PR appears to address all the requirements mentioned in this issue. Is there anything specific you'd like me to add or modify to the existing PR?

@bhouston
Copy link
Member Author

Completed: #280 #279

@bhouston
Copy link
Member Author

I've investigated the request to update documentation for gpustack (renamed to local-openai) and xai providers, and I can confirm that this task has already been completed:

  1. The documentation for both providers exists:

    • /packages/docs/docs/providers/local-openai.md - For GPUStack and other OpenAI-compatible servers
    • /packages/docs/docs/providers/xai.md - For Grok models from xAI
  2. The providers.ts file has been updated to include both providers with appropriate documentation URLs, default models, and baseUrls.

  3. The index.mdx file has been updated to reference both providers.

The documentation for the local-openai provider (formerly gpustack) includes comprehensive information about using GPUStack and other OpenAI-compatible servers with MyCoder, along with configuration examples, hardware requirements, and troubleshooting guidance.

PR #282 appears to be attempting to add content that already exists in the repository. This might be due to confusion about the state of the documentation after PR #279 was merged.

Is there anything specific about the documentation that still needs to be addressed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant