Skip to content

Re-write README for universal LLM schemas#221

Merged
samchon merged 1 commit intov6.0from
doc/readme
Dec 22, 2025
Merged

Re-write README for universal LLM schemas#221
samchon merged 1 commit intov6.0from
doc/readme

Conversation

@samchon
Copy link
Owner

@samchon samchon commented Dec 22, 2025

This pull request updates the README.md to modernize, clarify, and improve documentation for the @samchon/openapi library. The changes focus on making the documentation more accessible, emphasizing multi-provider support, simplifying code examples, and improving the presentation of key features and usage patterns.

Key improvements include:

Documentation Structure & Clarity

  • Refactored and expanded the feature list, highlighting multi-provider support (OpenAI, Claude, Qwen, Llama, etc.), production-readiness, and improved TypeScript type safety.
  • Reorganized and simplified code examples to show a clearer, step-by-step process for turning OpenAPI documents into LLM-callable applications, removing outdated or overly specific model references. [1] [2]
  • Updated and clarified the introductory sections and feature highlights for easier onboarding. [1] [2]

Multi-Provider & Type Safety Focus

  • Generalized all function calling examples and type definitions to be provider-agnostic, removing hardcoded model types and showing compatibility with any LLM provider. [1] [2] [3]
  • Added a summary table of type definitions for applications, functions, parameters, and schemas across HTTP and MCP contexts.

Enhanced Validation and Human-AI Collaboration

  • Improved documentation for runtime validation, including simplified example code and updated playground links. [1] [2]
  • Clarified and streamlined the validation feedback loop for fixing LLM mistakes, with updated sample code. [1] [2]
  • Added a new section on separating parameters between human and AI using the separate option, with a practical example.

Visual and Thematic Updates

  • Updated all Mermaid diagrams to use flowchart TB for consistency and improved flow direction. [1] [2] [3]
  • Replaced outdated or overly detailed diagrams and tables with more concise, modern representations. [1] [2]

Minor Corrections and Consistency

  • Fixed minor typos, improved link accuracy, and updated terminology for clarity (e.g., "AI-callable" vs. "type-safe LLM function calling"). [1] [2] [3]

These changes make the documentation more user-friendly and position @samchon/openapi as a robust, provider-agnostic solution for LLM function calling.


References:

Documentation Structure & Clarity

  • Refactored feature list and onboarding:
  • Simplified code examples and intro: [1] [2]

Multi-Provider & Type Safety Focus

  • Generalized examples and types: [1] [2] [3]
  • Added type definitions table:

Enhanced Validation and Human-AI Collaboration

  • Improved validation docs and playground links: [1] [2]
  • Updated validation feedback loop: [1] [2]
  • Added parameter separation section:

Visual and Thematic Updates

Minor Corrections and Consistency

  • Fixed typos and improved terminology: [1] [2] [3]

@samchon samchon self-assigned this Dec 22, 2025
Copilot AI review requested due to automatic review settings December 22, 2025 17:09
@samchon samchon added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 22, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR modernizes the @samchon/openapi README to emphasize universal LLM provider support, removing vendor-specific bias and simplifying the documentation for broader adoption. The update transforms the library's positioning from OpenAI/Claude/Gemini-specific to a provider-agnostic solution that works with any LLM supporting function calling.

Key changes:

  • Generalized all type definitions and examples to be provider-agnostic (removing model-specific generic parameters)
  • Simplified code examples and improved onboarding flow
  • Enhanced documentation for validation feedback and human-AI collaboration features

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
package.json Updated package description to emphasize multi-provider support; replaced "gemini" keyword with "qwen" to reflect broader LLM coverage
README.md Complete documentation overhaul: removed vendor-specific type parameters, simplified examples, added provider comparison table, enhanced validation and parameter separation sections, updated all Mermaid diagrams to use consistent flowchart direction

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@samchon samchon merged commit 532a920 into v6.0 Dec 22, 2025
10 checks passed
@samchon samchon deleted the doc/readme branch December 22, 2025 17:12
samchon added a commit that referenced this pull request Dec 23, 2025
* Unified to `ILlmSchema`, no more separation. (#213)

* Unified to `ILlmSchema`

* Complete the new `ILlmSchema` type

* detailed description comments

* Update src/structures/ILlmSchema.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/structures/ILlmSchema.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/structures/ILlmSchema.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* prettier

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Unify `ILlmApplication` and `ILlmFunction` too. (#214)

* Universal `LlmSchemaComposer` (#215)

* Universal LlmSchemaComposer

* complete `LlmSchemaComposer.schema()` function

* fix logics

* Universal `LlmTypeChecker` (#216)

* Universal `LlmTypeChecker`

* Fix `LlmSchemaComposer` to utilize `LlmTypeCheckeer`

* JSDoc comments on universal LLM types. (#217)

* Universal `HttpLlm` (#218)

* Universal `HttpLlm`

* Update src/HttpLlm.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/HttpLlm.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix configuration comments

* fix more thing

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Remove individual LLM schemas (#219)

* Remove individual LLM schemas

* fix

* Unify test functions about LLM schemas (#220)

* Unify test functions about LLM schemas

* Update test/src/utils/LlmApplicationFactory.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fixed most of test functions

* fixed most of test functions

* completed everything

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Publish v6

* Re-write README for universal LLM schemas (#221)

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant