docs(server): improve first-contributor experience#52
Merged
streamer45 merged 3 commits intomainfrom Feb 7, 2026
Merged
Conversation
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
streamer45
approved these changes
Feb 7, 2026
streamer45
approved these changes
Feb 7, 2026
5cfc20f to
a07fa78
Compare
- Fix broken `just dev` (cd server does not exist, use -p streamkit-server) - Add check-ui-dist pre-flight to `just skit` for a friendly error when ui/dist/ is missing instead of a cryptic RustEmbed compile error - Fix lint rebuild ping-pong in lint-skit/fix-skit by running the moq-featured clippy pass first then the workspace pass excluding streamkit-server - Expand CONTRIBUTING.md with detailed prerequisites (system packages, Rust tools, linting tools, plugin dev deps) - Expand docs/getting-started/installation.md with system library requirements and optional tooling for lint/dev/plugins Signed-off-by: Staging-Devin AI <166158716+staging-devin-ai-integration[bot]@users.noreply.github.com>
Signed-off-by: Staging-Devin AI <166158716+staging-devin-ai-integration[bot]@users.noreply.github.com>
Signed-off-by: Staging-Devin AI <166158716+staging-devin-ai-integration[bot]@users.noreply.github.com>
a07fa78 to
b32b29c
Compare
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.
Summary
Addresses several pain points discovered during a fresh Ubuntu 22.04 setup. Changes span the justfile (bug fixes + DX improvements), documentation (prerequisite coverage), and dependency updates.
Justfile fixes:
just devwas broken:cd serverreferenced a nonexistent directory. Fixed to runcargo watchfrom workspace root with-p streamkit-server.just skitnow gives a friendly error whenui/dist/is missing instead of a cryptic RustEmbed derive macro compile error. Newcheck-ui-distpre-flight recipe.lint-skit/fix-skitrebuild ping-pong eliminated: reordered to run the moq-featured clippy pass onstreamkit-serverfirst, then--workspace --exclude streamkit-serverfor the rest. This avoids the two passes invalidating each other's cache on every run (~30s saved on repeated lints).Documentation:
cargo-deny,reuse),cargo-watch, and native plugin dev deps (clang,libclang-dev).Dependency updates:
timecrate bumped 0.3.45 → 0.3.47 (+ transitive depsnum-conv,time-core,time-macros) to resolve RUSTSEC-2026-0009 (DoS via stack exhaustion in RFC 2822 parsing).bytescrate bumped 1.11.0 → 1.11.1 to resolve RUSTSEC-2026-0007 (integer overflow inBytesMut::reserve).Both were blocking
cargo denyin CI.Updates since last revision
devin@streamkit.dev) so that signature verification passes. No code changes.Review & Testing Checklist for Human
lint-skitno longer lintsstreamkit-serverwithout themoqfeature — only with it. There is one#[cfg(not(feature = "moq"))]usage atapps/skit/src/server.rs:3544(let _ = &app_state;, a dead-code suppression hint). Verify you're comfortable losing that no-moq lint coverage for the server crate.check-ui-distscope: currently wired only tojust skit. Other recipes that also needui/dist/(build-skit,skit-profiling,skit-console,skit-dhat) do not have this guard. Decide whether they should.just devon a machine withcargo-watchinstalled — confirm the backend starts and hot-reloads correctly. (Onlyjust skit servewas tested locally by Devin; hot-reload viacargo-watchwas not exercised.)just skitwithoutui/dist/— confirm the friendly error message appears instead of the RustEmbed compile error.Notes