CARS-29382: fix documentation#18
Merged
Merged
Conversation
iacutone
approved these changes
Dec 9, 2025
koobob
approved these changes
Dec 9, 2025
af43bf6 to
2b3236c
Compare
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.
What
Documentation Accuracy Audit for the
car_reqrepository. This PR:CHANGELOG.mdwith version history reconstructed from git tagsREADME.mdwith accurate version tags, complete options documentation, and fixes code examplesWhy
Part of the Marketplace Documentation & Governance initiative (CARS-29216). The goal is to ensure all documentation is accurate, current, and aligned with Marketplace standards to improve clarity for engineers and LLM tools like Cursor.
Jira ticket
CARS-29382
Steps to Validate/Verify
Review the documentation changes:
CHANGELOG.mdversion links resolve correctly on GitHubREADME.mdcode examples are syntactically correct@schemaoptions fromlib/car_req.exare documentedAdditional Notes
Changes Summary
CHANGELOG.md (new file):
README.md:
0.1.2→0.3.3base_url,finch,cache,cache_dir,compressed,compress_body, fuse options,resource_name_override):transientas valid retry optionAfter merge checklist:
mix.exsif releasing a new versionCHANGELOG.mdwith changesgit tag -a X.Y.Z -m "vX.Y.Z" && git push origin X.Y.Z