Skip to content

docs: add reference to frameworks documentation #94

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
wants to merge 1 commit into from

Conversation

sambarnes
Copy link
Contributor

@sambarnes sambarnes commented Jul 5, 2025

docs: add reference to frameworks documentation

Summary

This PR addresses GitHub issue #93 by adding a reference to the correct OpenRouter frameworks documentation in the README.md file. The issue reported that users were encountering a "page not found" error when trying to access frameworks documentation from the OpenRouter website.

Root Cause: The broken link https://openrouter.ai/docs/community/frameworks returns a 404 error, while the correct URL is https://openrouter.ai/docs/community/frameworks-overview.

Solution: Added a helpful reference to the correct frameworks documentation URL in the README.md file's "Supported models" section, making it easier for users to find integration guides for popular frameworks and SDKs.

Review & Testing Checklist for Human


Diagram

%%{ init : { "theme" : "default" }}%%
graph TD
    Issue["GitHub Issue #93<br/>page not found"]
    README["README.md<br/>Supported models section"]:::major-edit
    BrokenURL["https://openrouter.ai/docs/<br/>community/frameworks<br/>(404 Error)"]:::context
    CorrectURL["https://openrouter.ai/docs/<br/>community/frameworks-overview<br/>(Working)"]:::context
    
    Issue --> README
    README --> CorrectURL
    BrokenURL -.-> CorrectURL
    
    subgraph Legend
        L1[Major Edit]:::major-edit
        L2[Minor Edit]:::minor-edit  
        L3[Context/No Edit]:::context
    end
    
    classDef major-edit fill:#90EE90
    classDef minor-edit fill:#87CEEB
    classDef context fill:#FFFFFF
Loading

Notes

  • The change is minimal and low-risk - only adding a documentation reference
  • The frameworks documentation page contains integration guides for OpenAI SDK, LangChain, PydanticAI, Vercel AI SDK, and Mastra
  • This helps users discover the frameworks documentation they need without encountering broken links
  • Link to Devin run: https://app.devin.ai/sessions/58b26021f90549489e6c90ce51933b7f
  • Requested by: @sambarnes

Frameworks Documentation Screenshot

Copy link
Contributor

Original prompt from sam:

SYSTEM:
=== BEGIN THREAD HISTORY ===
GitHub (U05HMK4U3D1): 

[OpenRouterTeam/ai-sdk-provider] Issue opened by Boby900

sam (U06DJ8YS066): @Devin would you mind investigating this bug report? I think we have a broken link
=== END THREAD HISTORY ===

The latest message is the one right above that tagged you.

Copy link
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@sambarnes sambarnes closed this Jul 5, 2025
@sambarnes sambarnes deleted the devin/1751757719-fix-broken-frameworks-link branch July 5, 2025 23:26
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

Successfully merging this pull request may close these issues.

1 participant