Skip to content

Conversation

@Sander-Toonen
Copy link

No description provided.

Copilot AI review requested due to automatic review settings January 23, 2026 20:21
Copy link

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

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>
Copy link

Copilot AI commented Jan 23, 2026

@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>
@Sander-Toonen Sander-Toonen merged commit b6ec5ea into master Jan 23, 2026
4 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