Skip to content

docs: record LARQL phase 1 decisions - #174

Open
ttupper92618 wants to merge 8 commits into
mainfrom
feature/larql-phase-1-decisions-publisher
Open

docs: record LARQL phase 1 decisions#174
ttupper92618 wants to merge 8 commits into
mainfrom
feature/larql-phase-1-decisions-publisher

Conversation

@ttupper92618

@ttupper92618 ttupper92618 commented May 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add ADRs for the Phase 1 LARQL decisions: Worker-managed LarqlRunner, MLX head plus cold LARQL tier, and external vindex provenance.
  • Add Phase 2 internal LARQL runner isolation groundwork: strict LARQL shard/readiness types, worker-managed LarqlRunnerSupervisor, vindex directory staging support, readiness event application, and focused tests.
  • Update Skulk architecture docs, website architecture docs, and CLAUDE.md to reflect that LARQL supervision/readiness exists internally while slice placement remains gated.
  • Pair this with the public publisher repo and its Phase 2 MoE dry-run catalogue: https://github.com/Foxlight-Foundation/skulk-vindex-publisher.

Issue Tracking

Validation

  • uv run basedpyright
  • uv run ruff check
  • nix --extra-experimental-features "nix-command flakes" fmt
  • uv run pytest — 712 passed, 1 skipped, 167 deselected
  • uv run python scripts/build_docs.py
  • Publisher YAML/workflow parse
  • Publisher scripts/publish-vindex.sh --dry-run for all smoke and MoE catalogue keys

Docs build succeeded with existing TypeDoc/Docusaurus warnings only. Full pytest includes the existing noisy restart-test execv traceback, but the suite exits 0.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR records Phase 1 architectural decisions for the planned LARQL slice-placement roadmap by adding new ADRs and updating existing architecture/developer docs to describe the intended “MLX head + LARQL cold tier + external vindex provenance” model without implying runtime support exists yet.

Changes:

  • Added three Phase 1 ADRs covering LarqlRunner, MLX-head/LARQL-cold-tier execution, and vindex provenance/ownership.
  • Updated architecture docs (both repo docs and Docusaurus site docs) to describe the planned slice-mode constraints and gating.
  • Updated contributor/assistant guidance docs to point to the new ADR location and summarize the roadmap status.

Reviewed changes

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

Show a summary per file
File Description
website/docs/architecture.md Adds “planned, not active” LARQL slice-mode notes and constraints to the public architecture narrative.
website/docs/architecture-reference.md Adds a dense reference entry for the planned LarqlRunner and vindex sourcing invariant.
docs/architecture.md Mirrors planned slice-mode + vindex provenance guidance in the repo’s architecture overview.
docs/adr/README.md Introduces ADR format + numbering conventions for future decisions.
docs/adr/0001-larql-runner-type.md ADR for modeling LARQL as a worker-managed runner supervising larql-server.
docs/adr/0002-head-mlx-cold-larql.md ADR for keeping MLX as head runtime and using LARQL peers for cold FFN/expert slices (gated).
docs/adr/0003-vindex-provenance.md ADR defining Skulk as vindex consumer-only, with publishing owned by an external repo.
CONTRIBUTING.md Documents docs/adr/ as the location for architecture decision records.
CLAUDE.md Adds a concise summary of the planned slice-mode ADR decisions for assistant guidance.

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

Comment thread docs/adr/0001-larql-runner-type.md
Comment thread docs/adr/0002-head-mlx-cold-larql.md
Comment thread docs/adr/0002-head-mlx-cold-larql.md
Comment thread docs/adr/0003-vindex-provenance.md

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9d6f8ac539

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/exo/download/download_utils.py Outdated
Comment thread src/exo/download/impl_shard_downloader.py Outdated
Comment thread src/exo/worker/runner/larql_supervisor.py
Copilot AI review requested due to automatic review settings May 12, 2026 17:08

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

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

Comment thread src/exo/download/download_utils.py
Comment thread src/exo/download/download_utils.py Outdated
Comment thread src/exo/worker/runner/larql_supervisor.py Outdated
Comment thread src/exo/worker/runner/larql_supervisor.py
Comment thread src/exo/worker/runner/larql_supervisor.py
Comment thread src/exo/worker/runner/larql_supervisor.py
Comment thread docs/adr/0001-larql-runner-type.md

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4c0b95deec

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/exo/worker/runner/larql_supervisor.py

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 33ff860eb6

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/exo/download/download_utils.py Outdated
Comment thread src/exo/worker/runner/larql_supervisor.py
Copilot AI review requested due to automatic review settings May 12, 2026 17:35

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 27 out of 27 changed files in this pull request and generated 4 comments.

Comment thread src/exo/worker/runner/larql_supervisor.py
Comment thread src/exo/download/download_utils.py Outdated
Comment thread src/exo/download/impl_shard_downloader.py
Comment thread src/exo/worker/plan.py

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e924ce94b6

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/exo/worker/runner/larql_supervisor.py Outdated
Comment thread src/exo/download/download_utils.py Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0abdd07cd4

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/exo/download/coordinator.py Outdated
Comment thread src/exo/download/download_utils.py Outdated
Copilot AI review requested due to automatic review settings May 14, 2026 03:56

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 27 out of 27 changed files in this pull request and generated 6 comments.

Comment thread src/exo/shared/types/worker/larql.py
Comment thread src/exo/worker/runner/larql_supervisor.py
Comment thread src/exo/worker/runner/larql_supervisor.py
Comment thread src/exo/worker/runner/larql_supervisor.py
Comment thread src/exo/worker/runner/larql_supervisor.py
Comment thread src/exo/shared/types/worker/shards.py

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6733402fde

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/exo/download/download_utils.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants