Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request significantly improves the documentation structure and adds comprehensive JSDoc comments to the language service utilities. The PR reorganizes the documentation into audience-specific sections and adds a MkDocs configuration for generating a documentation website.
Changes:
- Added comprehensive JSDoc comments to language service utility functions (
src/language-service/ls-utils.ts) - Introduced MkDocs configuration for documentation site generation
- Reorganized documentation into audience-specific sections (Expression Writers, Developers, Contributors)
- Created new documentation files (quick-reference.md, migration.md, contributing.md, breaking-changes.md, advanced-features.md, index.md)
- Updated and improved existing documentation with better examples and formatting
- Added audience tags to documentation files for clarity
- Minor code improvements (removed unused error variable, fixed trailing whitespace)
Reviewed changes
Copilot reviewed 18 out of 20 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/language-service/ls-utils.ts | Added comprehensive JSDoc comments for all exported functions and introduced TokenSpan interface with documentation |
| src/language-service/language-service.ts | Removed unused error variable from catch block |
| src/language-service/diagnostics.ts | Fixed trailing whitespace in JSDoc comment |
| mkdocs.yml | New MkDocs configuration file for documentation site with Material theme |
| docs/syntax.md | Extensive rewrite with improved examples, better organization, and audience-appropriate language |
| docs/quick-reference.md | New quick reference cheat sheet for expression syntax |
| docs/parser.md | Major rewrite with better structure, examples, and comprehensive API documentation |
| docs/migration.md | New migration guide for users upgrading from original expr-eval or previous versions |
| docs/index.md | New documentation home page with overview and navigation guide |
| docs/expression.md | Updated code examples to use modern import syntax and consistent formatting |
| docs/enhancements.md | Reorganized to redirect to new advanced-features.md with summary of enhancements |
| docs/contributing.md | New contributor guide for the documentation site |
| docs/breaking-changes.md | New breaking changes documentation for the documentation site |
| docs/advanced-features.md | New comprehensive guide for advanced integration features |
| docs/performance.md | Added audience tag for contributors |
| docs/language-service.md | Added audience tag for developers |
| README.md | Reorganized documentation links into audience-specific sections |
| CONTRIBUTING.md | New root-level contributing guide for GitHub |
| BREAKING_CHANGES.md | Added Version 4.0.0 breaking changes section |
| .gitignore | Added site/ directory for MkDocs build output |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@Sander-Toonen I've opened a new pull request, #38, to work on those changes. Once the pull request is ready, I'll request review from you. |
* Initial plan * Remove duplicate TokenSpan interface Co-authored-by: Sander-Toonen <5106372+Sander-Toonen@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Sander-Toonen <5106372+Sander-Toonen@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.
No description provided.