Skip to content

task: add CHANGELOG, LLMS docs, and enhance type definitions#22

Merged
bombillazo merged 5 commits into
mainfrom
task/update-repo-files
Jan 25, 2026
Merged

task: add CHANGELOG, LLMS docs, and enhance type definitions#22
bombillazo merged 5 commits into
mainfrom
task/update-repo-files

Conversation

@bombillazo
Copy link
Copy Markdown
Owner

Summary

  • Add CHANGELOG.md documenting full version history from 0.1.0 to 0.6.0
  • Add LLMS.md with AI-friendly documentation containing usage examples and API reference
  • Enhance JSDoc documentation across resolver and preset modules with @example tags
  • Add .gitattributes for custom merge strategy on JSONL files

Test plan

  • Verify pnpm typecheck passes
  • Verify pnpm lint passes
  • Verify pnpm test passes
  • Review CHANGELOG.md follows Keep a Changelog format
  • Review LLMS.md examples are accurate and runnable

🤖 Generated with Claude Code

- Introduced .gitattributes for custom merge strategy on JSONL files.
- Created CHANGELOG.md to document project changes and versioning.
- Added LLMS.md for comprehensive usage examples and core concepts of the error-x library.
- Enhanced type definitions and documentation in index.ts and resolver.ts for better clarity and usability.
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds project documentation artifacts (CHANGELOG + AI-friendly docs) and expands JSDoc/module documentation around the public API, plus some repo-level git configuration updates.

Changes:

  • Add CHANGELOG.md with version history entries and compare links.
  • Add LLMS.md with usage examples and a consolidated API/type reference.
  • Expand module/JSDoc documentation in type and preset entrypoints and in ErrorXResolver, and add git ignore/attributes entries.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
src/types/index.ts Adds module/package documentation for exported type groups.
src/resolver.ts Enhances JSDoc for resolver internals with clearer behavior notes and examples.
src/presets/index.ts Adds module/package docs describing preset error exports and usage examples.
LLMS.md Introduces an AI-friendly usage/API reference document.
CHANGELOG.md Introduces a Keep a Changelog formatted changelog with historical entries.
.gitignore Ignores additional local/dev-tool artifacts.
.gitattributes Adds a custom merge attribute targeting a JSONL file path.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread LLMS.md Outdated
Comment thread LLMS.md Outdated
Comment thread LLMS.md Outdated
Comment thread src/presets/index.ts Outdated
Comment thread .gitattributes
Comment thread LLMS.md Outdated
Comment thread LLMS.md Outdated
Comment thread LLMS.md
Comment thread CHANGELOG.md
bombillazo and others added 3 commits January 25, 2026 13:14
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@bombillazo bombillazo merged commit a857b3b into main Jan 25, 2026
3 checks passed
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