Skip to content

docs: status, the hosted Jev note, and an honest roadmap - #20

Merged
hallelx2 merged 2 commits into
mainfrom
halleluyaholudele/hal-2664-docs-current-architecture
Oct 11, 2026
Merged

hallelx2 merged 2 commits into
mainfrom
halleluyaholudele/hal-2664-docs-current-architecture

Conversation

@hallelx2

@hallelx2 hallelx2 commented Oct 11, 2026 •

Copy link
Copy Markdown
Owner

Adds the project status, notes that Jev is a hosted TypeSafe API, and relabels Coming next as Planned, not done.

Verified on Lorx CI (GitHub Actions can't start jobs on this account, HAL-1712).

Closes HAL-2713

Summary by Sourcery

Set accurate expectations for the project's status, hosted Jev integration, known performance limitations, and planned work.

Enhancements:

  • Clarify the project's maintenance status, current release, and a known performance issue affecting local token counting.
  • Describe Jev as TypeSafe's hosted API and document its current configuration behavior.
  • Rename the roadmap's “Coming next” section to “Planned, not done” to distinguish planned work from implemented features.

Documentation:

  • Update the README with project status, Jev hosting details, roadmap terminology, and links to the relevant open fixes and supporting reports.

…atus

The README did not say that on v0.5.0 the TypeSafe guard rebuilds its
cl100k tokenizer on every count (about 256 ms each), which made a
Vectorless query spend most of 50 s on CPU. Say so under Status, link
the open fix (PR #19) and the measurement, and note that Vectorless's
engine pins that branch. Name the hosted-API nature of Jev, the
jev-latest default, and that environment base URL/model is still in
open PR #18. Add the project status note and relabel "Coming next" as
planned, not done.

Refs HAL-2664
@sourcery-ai

sourcery-ai Bot commented Oct 11, 2026

Copy link
Copy Markdown

Sorry @hallelx2, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 1 day and 10 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@coderabbitai

coderabbitai Bot commented Oct 11, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 29 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 2b39ec04-75a8-445d-bfce-e2e3b760223f

📥 Commits

Reviewing files that changed from the base of the PR and between 5790d3c and 9295004.


📒 Files selected for processing (1)
  • README.md

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@sourcery-ai

sourcery-ai Bot commented Oct 11, 2026

Copy link
Copy Markdown

Reviewer's Guide

Updates README.md to provide an honest project-status statement, clarify that Jev is a hosted TypeSafe API, distinguish planned features from completed work, and document the current local token-counting performance issue and related open fixes.

File-Level Changes

Change Details Files
Documents the project’s maintenance status and makes the roadmap and known limitations explicit.
  • States that Vectorless’s hosted service is closing while llmgate remains open source but inactive.
  • Adds release/version context, contact information, and a detailed TypeSafe token-counting performance issue with links to the proposed fix and measurements.
  • Relabels “Coming next” as “Planned, not done” to distinguish implemented features from roadmap items.
README.md
Clarifies the TypeSafe integration and its current configuration boundaries.
  • Describes Jev as TypeSafe’s hosted API and documents the default model alias and API-key environment variable.
  • Links the open work for configuring the base URL and model from the environment.
README.md
Documents the runtime cost of local batch token validation.
  • Notes that the transport performs local token counting before sending requests.
  • Cross-references the Status section for the known performance impact.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@hallelx2
hallelx2 merged commit 6dc09b4 into main Oct 11, 2026
2 of 7 checks passed
@hallelx2
hallelx2 deleted the halleluyaholudele/hal-2664-docs-current-architecture branch October 11, 2026 22:45
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.

1 participant