Skip to content

add moosestack-lsp documentation#3453

Merged
onelesd merged 8 commits intomainfrom
dave/eng-2129-add-moose-language-server-docs-to-moose-docs
Feb 4, 2026
Merged

add moosestack-lsp documentation#3453
onelesd merged 8 commits intomainfrom
dave/eng-2129-add-moose-language-server-docs-to-moose-docs

Conversation

@onelesd
Copy link
Contributor

@onelesd onelesd commented Feb 4, 2026

Note

Low Risk
Low risk documentation-only change that adds a new docs page and a navigation entry; no runtime behavior is modified.

Overview
Adds a new MooseStack docs page, moosestack/language-server, describing the experimental MooseStack LSP for TypeScript sql template literals (diagnostics, autocomplete, hover docs, formatting) with install and learn-more links.

Updates the MooseStack navigation to include a Language Server entry (TypeScript-only) under Fundamentals.

Written by Cursor Bugbot for commit 60f4ce7. This will update automatically on new commits. Configure here.

Cursor Bugbot reviewed your changes and found no issues for commit 60f4ce7

@linear
Copy link

linear bot commented Feb 4, 2026

@vercel
Copy link

vercel bot commented Feb 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-v2 Ready Ready Preview, Comment Feb 4, 2026 9:40pm

Request Review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 4, 2026

Summary by CodeRabbit

  • Documentation
    • Added new MooseStack Language Server documentation covering real-time ClickHouse SQL intelligence with error diagnostics, auto-complete suggestions, and hover documentation for TypeScript projects. Includes installation guides for VS Code and Cursor.

Walkthrough

Added a new MooseStack Language Server documentation page (TypeScript-only, experimental) describing real-time SQL intelligence in sql tagged templates (diagnostics, autocomplete, hover, code actions) and added a navigation entry to surface the page at moosestack/language-server.

Changes

Cohort / File(s) Summary
Docs & Nav
apps/framework-docs-v2/content/moosestack/language-server.mdx, apps/framework-docs-v2/src/config/navigation.ts
Added a new MDX doc for the MooseStack Language Server (features, installation, images, repo link; marked experimental, TypeScript-only). Added navigation item moosestack/language-server (IconFileCode, languages: ["typescript"]).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • callicles
  • oatsandsugar

Poem

A MooseStack beacon, docs now unfurled,
SQL hints and hover light the TypeScript world,
Experimental badge, a friendly sign,
Nav added to guide the curious mind. 🦫✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'add moosestack-lsp documentation' directly and clearly describes the main change: adding documentation for the MooseStack Language Server.
Description check ✅ Passed The description is related to the changeset, providing context about the new documentation page and navigation entry added.
Linked Issues check ✅ Passed The PR implements ENG-2129 by adding MooseStack Language Server documentation to the docs site with a new page and navigation entry.
Out of Scope Changes check ✅ Passed All changes are in-scope: a new documentation file and navigation config update directly fulfill the objective of documenting the MooseStack LSP.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dave/eng-2129-add-moose-language-server-docs-to-moose-docs

📜 Recent review details

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between bdc9e64 and 60f4ce7.

⛔ Files ignored due to path filters (3)
  • apps/framework-docs-v2/public/lsp-autocomplete.png is excluded by !**/*.png
  • apps/framework-docs-v2/public/lsp-error-diagnostics.png is excluded by !**/*.png
  • apps/framework-docs-v2/public/lsp-hover-docs.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • apps/framework-docs-v2/content/moosestack/language-server.mdx
🧰 Additional context used
📓 Path-based instructions (1)
apps/framework-docs-v2/content/**/*.mdx

📄 CodeRabbit inference engine (apps/framework-docs-v2/CLAUDE.md)

apps/framework-docs-v2/content/**/*.mdx: Use {{ include "shared/path.mdx" }} directives to reuse content fragments, which are processed via processIncludes() during build
Validate code snippets in documentation with the @test directive for TypeScript and Python code blocks
TypeScript code snippets in documentation should be validated for syntax with brace matching; Python snippets should be validated for indentation

Files:

  • apps/framework-docs-v2/content/moosestack/language-server.mdx
🧠 Learnings (3)
📓 Common learnings
Learnt from: CR
Repo: 514-labs/moosestack PR: 0
File: examples/nextjs-moose/CLAUDE.md:0-0
Timestamp: 2026-01-27T17:36:29.854Z
Learning: Applies to examples/nextjs-moose/moose/src/query-examples/**/*.ts : Query example functions must use `eventsModel.toSql()` to generate SQL, ensuring consistent query construction through the defined model
📚 Learning: 2026-01-22T19:02:52.316Z
Learnt from: CR
Repo: 514-labs/moosestack PR: 0
File: apps/framework-docs-v2/CLAUDE.md:0-0
Timestamp: 2026-01-22T19:02:52.316Z
Learning: Applies to apps/framework-docs-v2/content/**/*.mdx : TypeScript code snippets in documentation should be validated for syntax with brace matching; Python snippets should be validated for indentation

Applied to files:

  • apps/framework-docs-v2/content/moosestack/language-server.mdx
📚 Learning: 2026-01-28T14:50:00.978Z
Learnt from: cjus
Repo: 514-labs/moosestack PR: 3407
File: apps/framework-docs-v2/content/guides/static-report-generation.mdx:1402-1406
Timestamp: 2026-01-28T14:50:00.978Z
Learning: When reviewing WebApp implementations that run in a Node.js backend, prefer Node.js-specific types (e.g., Buffer) and avoid browser-focused cross-platform compatibility considerations. This guideline applies to MDX documentation and code examples across the repository where backend/runtime code is discussed; ensure reviewers distinguish server-side context from frontend/browser constraints and validate type usage accordingly.

Applied to files:

  • apps/framework-docs-v2/content/moosestack/language-server.mdx
🔇 Additional comments (1)
apps/framework-docs-v2/content/moosestack/language-server.mdx (1)

26-34: All referenced image assets are present in apps/framework-docs-v2/public/ and will render correctly.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@apps/framework-docs-v2/content/moosestack/language-server.mdx`:
- Around line 26-32: Replace the plain text "visit the GitHub repo" with a
clickable Markdown link to the MooseStack LSP repository (e.g. change the
sentence "For other installation methods visit the GitHub repo." to use [GitHub
repo](https://github.com/514-labs/moosestack-lsp)); update the line near the
"For VS Code and Cursor..." sentence in the file where that exact phrase appears
so users can click through directly.
📜 Review details

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 3522f89 and aece941.

📒 Files selected for processing (2)
  • apps/framework-docs-v2/content/moosestack/language-server.mdx
  • apps/framework-docs-v2/src/config/navigation.ts
🧰 Additional context used
📓 Path-based instructions (4)
**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Run linting checks before submitting PRs for TypeScript/JavaScript code

**/*.{ts,tsx,js,jsx}: Group imports by external dependencies, internal modules, and types; use named exports from barrel files (index.ts)
Use camelCase for variables and functions, PascalCase for types/classes/components, UPPER_SNAKE_CASE for constants in TypeScript/JavaScript
Prefix unused variables with underscore (e.g., _unusedParam) to bypass linting errors in TypeScript/JavaScript
Format TypeScript/JavaScript code with Prettier using experimentalTernaries: true; auto-formats on commit via Husky + lint-staged

Files:

  • apps/framework-docs-v2/src/config/navigation.ts
apps/framework-docs-v2/src/**/*.{ts,tsx}

📄 CodeRabbit inference engine (apps/framework-docs-v2/CLAUDE.md)

Component library must use shadcn/ui components located in src/components/ui/

Files:

  • apps/framework-docs-v2/src/config/navigation.ts
**/*.{ts,tsx}

📄 CodeRabbit inference engine (AGENTS.md)

Prefer interfaces for objects, types for unions/intersections in TypeScript; explicit return types on public APIs

Files:

  • apps/framework-docs-v2/src/config/navigation.ts
apps/framework-docs-v2/content/**/*.mdx

📄 CodeRabbit inference engine (apps/framework-docs-v2/CLAUDE.md)

apps/framework-docs-v2/content/**/*.mdx: Use {{ include "shared/path.mdx" }} directives to reuse content fragments, which are processed via processIncludes() during build
Validate code snippets in documentation with the @test directive for TypeScript and Python code blocks
TypeScript code snippets in documentation should be validated for syntax with brace matching; Python snippets should be validated for indentation

Files:

  • apps/framework-docs-v2/content/moosestack/language-server.mdx
🧠 Learnings (3)
📚 Learning: 2026-01-22T19:02:52.316Z
Learnt from: CR
Repo: 514-labs/moosestack PR: 0
File: apps/framework-docs-v2/CLAUDE.md:0-0
Timestamp: 2026-01-22T19:02:52.316Z
Learning: Add new guides to `guidesNavigationConfig` in `src/config/navigation.ts` with required fields: type, slug, title, icon, languages, and status (start as 'draft')

Applied to files:

  • apps/framework-docs-v2/src/config/navigation.ts
📚 Learning: 2026-01-22T19:02:52.316Z
Learnt from: CR
Repo: 514-labs/moosestack PR: 0
File: apps/framework-docs-v2/CLAUDE.md:0-0
Timestamp: 2026-01-22T19:02:52.316Z
Learning: Navigation configuration must be manually maintained in `src/config/navigation.ts` and not auto-generated from file structure

Applied to files:

  • apps/framework-docs-v2/src/config/navigation.ts
📚 Learning: 2026-01-28T14:50:00.978Z
Learnt from: cjus
Repo: 514-labs/moosestack PR: 3407
File: apps/framework-docs-v2/content/guides/static-report-generation.mdx:1402-1406
Timestamp: 2026-01-28T14:50:00.978Z
Learning: When reviewing WebApp implementations that run in a Node.js backend, prefer Node.js-specific types (e.g., Buffer) and avoid browser-focused cross-platform compatibility considerations. This guideline applies to MDX documentation and code examples across the repository where backend/runtime code is discussed; ensure reviewers distinguish server-side context from frontend/browser constraints and validate type usage accordingly.

Applied to files:

  • apps/framework-docs-v2/content/moosestack/language-server.mdx
🔇 Additional comments (2)
apps/framework-docs-v2/content/moosestack/language-server.mdx (1)

1-16: LGTM!

Frontmatter is correct, Callout import and usage are appropriate, and the experimental status is clearly communicated.

apps/framework-docs-v2/src/config/navigation.ts (1)

203-209: LGTM!

Navigation entry correctly structured. TypeScript-only language array aligns with the experimental LSP feature scope. Placement under Fundamentals is appropriate.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

@onelesd onelesd force-pushed the dave/eng-2129-add-moose-language-server-docs-to-moose-docs branch from aece941 to a617efa Compare February 4, 2026 18:19
@onelesd onelesd requested a review from oatsandsugar February 4, 2026 18:25
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.

@onelesd onelesd enabled auto-merge February 4, 2026 21:39
@onelesd onelesd added this pull request to the merge queue Feb 4, 2026
Merged via the queue into main with commit 3d645cb Feb 4, 2026
30 checks passed
@onelesd onelesd deleted the dave/eng-2129-add-moose-language-server-docs-to-moose-docs branch February 4, 2026 22:40
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