Skip to content

Standardize provider documentation format#52

Merged
robinebers merged 1 commit intomainfrom
robinebers/provider-doc-format
Feb 3, 2026
Merged

Standardize provider documentation format#52
robinebers merged 1 commit intomainfrom
robinebers/provider-doc-format

Conversation

@robinebers
Copy link
Owner

@robinebers robinebers commented Feb 3, 2026

All three provider docs (Claude, Codex, Cursor) now follow a consistent structure: Overview, Endpoints, and Authentication sections. Field documentation is consolidated into jsonc comments, eliminating redundant field tables. Code examples removed. No factual information lost, only presentation simplified for minimal, scannable format.

Co-Authored-By: Claude Haiku 4.5 noreply@anthropic.com


Note

Low Risk
Documentation-only refactor that mainly restructures and trims content; low risk aside from potential loss of minor explanatory nuance during consolidation.

Overview
Standardizes the Claude, Codex, and Cursor provider docs into a consistent, more scannable structure with Overview, Endpoints, and Authentication sections.

Consolidates field explanations into inline jsonc comments and header tables, and removes the longer narrative sections and code examples, while keeping the documented endpoints, auth/token locations, and refresh details intact.

Written by Cursor Bugbot for commit fe5dd4d. This will update automatically on new commits. Configure here.


Summary by cubic

Standardized Claude, Codex, and Cursor provider docs into a minimal, consistent format to make them easier to scan and maintain. No technical content removed; presentation is simplified.

  • Refactors
    • Unified structure: Overview, Endpoints, Authentication.
    • Moved field details into inline jsonc comments; removed redundant tables and code examples.
    • Preserved endpoint specs, required headers, token locations, and refresh flows.

Written for commit fe5dd4d. Summary will update on new commits.

Restructure Claude, Codex, and Cursor provider docs to follow a consistent template with Overview, Endpoints, and Authentication sections. Consolidate field documentation into jsonc comments. Remove code examples and redundant field tables to reduce noise while preserving all technical details.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@macroscopeapp
Copy link

macroscopeapp bot commented Feb 3, 2026

Standardize provider docs formatting and usage/auth sections in docs/providers/claude.md, docs/providers/codex.md, and docs/providers/cursor.md to align titles, overviews, endpoints, headers, and token refresh details

Unify provider documentation structure across Claude Code, Codex, and Cursor with consistent Overview blocks, explicit usage endpoints and headers, condensed authentication token locations, and minimal token refresh examples; remove verbose subsections and examples.

📍Where to Start

Start with the Claude provider doc to see the new pattern in claude.md, then compare with codex.md and cursor.md.


Macroscope summarized fe5dd4d.

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 3 files

@robinebers robinebers merged commit 9e276bf into main Feb 3, 2026
3 checks passed
@robinebers robinebers deleted the robinebers/provider-doc-format branch February 3, 2026 07:24
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