Skip to content

Fix README accuracy issues#16

Merged
larkiny merged 1 commit intomainfrom
docs/readme-accuracy-fixes
Feb 12, 2026
Merged

Fix README accuracy issues#16
larkiny merged 1 commit intomainfrom
docs/readme-accuracy-fixes

Conversation

@larkiny
Copy link
Copy Markdown
Owner

@larkiny larkiny commented Feb 12, 2026

Summary

  • Remove fabricated "Link Transformation Utilities" section that referenced three non-existent functions (createLinkTransform, extractAnchor, removeMarkdownExtension)
  • Remove LoaderContext type import from Quick Start (internal type, not part of public API)
  • Fix LinkMapping interface: replace non-existent description property with actual contextFilter and relativeLinks properties
  • Fix IncludePattern.pathMappings type from Record<string, string> to Record<string, PathMappingValue> to reflect enhanced object format support
  • Update performance descriptions from "Smart directory scanning" to "Git Trees API" to match actual implementation

Test plan

  • tsc --noEmit passes
  • All 297 tests pass
  • Verified all interface definitions match actual types in github.types.ts
  • Verified all referenced exports exist in src/index.ts

…ct interfaces

- Remove fabricated "Link Transformation Utilities" section referencing
  createLinkTransform, extractAnchor, removeMarkdownExtension (none exist)
- Remove LoaderContext import from Quick Start (internal type, not exported)
- Fix LinkMapping interface: remove non-existent description property,
  add actual contextFilter and relativeLinks properties
- Fix IncludePattern.pathMappings type to use PathMappingValue (supports
  both string and enhanced object format with crossSectionPath)
- Update performance descriptions from "Smart directory scanning" to
  "Git Trees API" to match actual implementation
- Remove description property from link mapping examples
@larkiny larkiny merged commit 79cca91 into main Feb 12, 2026
1 check passed
@larkiny larkiny deleted the docs/readme-accuracy-fixes branch February 12, 2026 18:14
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