Repository navigation
Conversation
Replace named gateway examples with fictional Adatum placeholders and add N6 to keep documentation focused on integration mechanisms rather than provider directories or promotion. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
GOALS.md adds a new project non-goal requiring @robgruen’s explicit approval, but the linked discussion requests the proposal without approving its final wording.
No open issues 🎉
What changed in this PR
Makes gateway documentation provider-neutral while preserving OpenAI-compatible endpoint support. The proposed policy remains subject to owner approval and merge; library behavior and APIs are unchanged.
Changes:
- Proposes N6 to favor integration guidance over commercial provider listings, while retaining names needed to explain implemented APIs and adapters.
- Replaces named gateway examples with clearly marked fictional Adatum endpoints.
- Clarifies that users must supply their gateway’s actual URL, API key, and model name.
| File | Description |
|---|---|
site/src/docs/typescript/basic-usage.md |
Uses fictional gateway URLs in TypeScript and environment configuration examples. |
site/src/docs/python/basic-usage.md |
Uses fictional gateway URLs in Python and environment configuration examples. |
site/src/docs/examples.md |
Provides a complete, provider-neutral gateway configuration with placeholder guidance. |
GOALS.md |
Proposes N6 while explicitly preserving compatible endpoint support. |
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
https://api.adatum.com/v1/chat/completions.Context and scope
Owner-requested follow-up to #527 and the documentation-policy discussion. Apply the same vendor-neutral standard to existing named examples rather than adding another commercial gateway listing.
This changes documentation and proposes an explicit project non-goal; it does not remove OpenAI-compatible gateway support or change library APIs, validation, dependencies, or supported integrations. OpenAI/Azure OpenAI API and adapter documentation remains appropriate. Historical assessment reports are unchanged.
The new non-goal is proposed policy until owner approval and merge; this PR does not close #527.
Validation
Using the repository-pinned Node.js 24.22.1:
site:npm run build— passed; 13 pages generated.tools:node --test --test-name-pattern "project direction|direction policy" tests/backlog-assessment.test.mjs— 2 passed.git diff --check— passed.No live gateway requests are needed or made for fictional examples.