Fix thisChapterAudioLinks duplication in API documentation #26
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.
Issue
The API documentation in
docs/reference/README.mdhad an error in the TypeScript interface definition forTranslationBookChapter. The property for next chapter audio links was incorrectly namedthisChapterAudioLinksinstead ofnextChapterAudioLinks, creating a duplicate property name.Changes
This PR fixes the documentation to match the actual TypeScript interface defined in
packages/helloao-tools/generation/api.ts:thisChapterAudioLinkson line 367 tonextChapterAudioLinks| nullto bothnextChapterAudioLinksandpreviousChapterAudioLinksto accurately reflect that these properties can be nullpreviousChapterAudioLinksfrom "Null if this is the last chapter" to "Null if this is the first chapter"Before
After
The documentation now correctly matches the actual API implementation and the JSON examples already present in the same file.
Fixes #[issue number]
Original prompt
Fixes #25
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.