Skip to content

Fix documentation consistency: Add missing toolNormalization to CONFIGURATION.md and resolve cross-reference issues#32

Merged
pardeike merged 3 commits intomainfrom
copilot/fix-cdc3d659-e5c4-43a3-833c-93269beab33e
Sep 14, 2025
Merged

Fix documentation consistency: Add missing toolNormalization to CONFIGURATION.md and resolve cross-reference issues#32
pardeike merged 3 commits intomainfrom
copilot/fix-cdc3d659-e5c4-43a3-833c-93269beab33e

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Sep 14, 2025

Problem

The enableOpenAINormalization configuration option was only documented in OPENAI_TOOL_NORMALIZATION.md but completely missing from the main CONFIGURATION.md guide. This created a poor user experience where users couldn't find this important OpenAI compatibility feature in the primary configuration documentation.

Additionally, the documentation had several consistency issues:

  • References to non-existent gabpMode configuration field
  • Missing cross-references between related guides
  • Outdated GABP architecture descriptions
  • Incomplete command line flag documentation

Solution

Added toolNormalization to Main Configuration Guide

The CONFIGURATION.md now includes a complete toolNormalization section with all options:

{
  "version": "1.0",
  "toolNormalization": {
    "enableOpenAINormalization": false,
    "maxToolNameLength": 64,
    "preserveOriginalName": true
  },
  "games": {
    // ... game configurations
  }
}

Fixed Code-Documentation Inconsistencies

  • Removed gabpMode references: This field doesn't exist in the actual GameConfig struct but was shown in documentation examples
  • Updated GABP architecture: Documentation now correctly reflects the local-only communication model currently implemented
  • Fixed bridge configuration: Accurate representation of the actual BridgeJSON structure

Added Comprehensive Cross-Reference System

Every documentation file now includes clear cross-references:

  • README.md provides a complete navigation index
  • Each guide links to related documentation
  • Users can easily navigate between configuration, integration, and advanced topics

Completed Command Line Documentation

Added missing CLI flags and corrected environment variables:

  • --log-level, --grace flags now documented
  • Fixed environment variable names (GABS_CONFIG_DIR vs outdated GAB_CONFIG_DIR)
  • Added complete mod environment variables (GABP_SERVER_PORT, GABP_TOKEN, etc.)

Impact

Users can now:

  1. Find enableOpenAINormalization easily in the main configuration guide
  2. Navigate seamlessly between related documentation topics
  3. Trust the examples - all configuration examples match the actual code implementation
  4. Reference complete CLI options - no more guessing about available flags

The documentation is now fully consistent with the codebase and provides a cohesive user experience.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI and others added 2 commits September 14, 2025 14:41
….md and update cross-references

Co-authored-by: pardeike <853584+pardeike@users.noreply.github.com>
… variables

Co-authored-by: pardeike <853584+pardeike@users.noreply.github.com>
Copilot AI changed the title [WIP] the option enableOpenAINormalization is only shown in some sub page but not in the main CONFIGURATION.md (not even as a link). Can you go over the documentation as a whole (all files, cross check everything so its consistent and makes sense to a user) ... Fix documentation consistency: Add missing toolNormalization to CONFIGURATION.md and resolve cross-reference issues Sep 14, 2025
Copilot AI requested a review from pardeike September 14, 2025 14:43
@pardeike pardeike marked this pull request as ready for review September 14, 2025 14:44
@pardeike pardeike merged commit 5d8aaa2 into main Sep 14, 2025
1 check passed
@pardeike pardeike deleted the copilot/fix-cdc3d659-e5c4-43a3-833c-93269beab33e branch September 14, 2025 14:44
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.

2 participants