task: add CHANGELOG, LLMS docs, and enhance type definitions#22
Merged
Conversation
- 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.
Contributor
There was a problem hiding this comment.
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.mdwith version history entries and compare links. - Add
LLMS.mdwith 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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Summary
@exampletagsTest plan
pnpm typecheckpassespnpm lintpassespnpm testpasses🤖 Generated with Claude Code