docs: rewrite QUICKSTART and CONTRIBUTING for OSS contributors#11
Merged
Conversation
Both docs previously targeted operators integrating a real EDR with a managed Vyrox dashboard at app.vyrox.dev. That dashboard does not exist yet and the docs were aspirational. QUICKSTART now walks an OSS contributor from git clone to a signed execution request hitting a local proxy in about ten minutes. No EDR account, no Discord, no Python runtime, no Docker. Just cargo and bash. Covers: - Building the proxy with cargo - Running it with DRY_RUN=true (the default) so no real EDR call is possible - Signing a /execute payload with openssl + curl - Inspecting the resulting audit JSONL entry - Running the simulator in --dry-run to see the wire format - Common failure modes (401, 410, missing env) CONTRIBUTING is now an actual contributor workflow doc instead of a two-line "open a PR". Covers: - The three repositories that accept outside contributions - Branch and commit naming conventions - What we will merge and what we will not (with concrete examples from past review threads) - Local test commands per repo - Code style rules including the no-em-dash discipline that drove this rewrite - Reviewer expectations on both public and private PRs - The three documentation rules: document what is, quote the file, update docs in the same PR Cross-refs to ARCHITECTURE.md, AUDIT_CHAIN.md, ADAPTERS.md resolve once those land via PRs #8, #9, #10.
3 tasks
keirsalterego
added a commit
that referenced
this pull request
May 23, 2026
The previous ROADMAP carried ARR targets, pilot counts, quarterly revenue numbers, and an MSP channel percentage. That material moved to vyrox-design-partners/docs/gtm/INTERNAL_ROADMAP_WITH_TARGETS.md in PR #9 of that repo. This commit lands its replacement. The new ROADMAP is organised by capability, not by quarter or by revenue tier. Sections: - Recently shipped: the sixteen blockers from the May 2026 audits (eight P0 + eight P0.5), each described as a public contract change with the file paths a reader can verify. - In flight: items that touch a public contract, with the actual bottleneck called out (Postgres before tenant 25, retry runner not yet wired into worker entrypoint, etc). - Planned, not started: public OpenAPI spec, customer-side audit verifier binary, EU data region, web operator interface trigger conditions. - Adapter coverage: shipped vendors plus on-demand future adapters. - Compliance and certification: where we are honest about what is in flight versus planned versus not started. - Versioning and release cadence: semver intent for the public repos. - "Intentionally not on the roadmap": SIEM, managed human SOC, web dashboard during alpha, free public ingestion endpoint. Cross-refs to ARCHITECTURE.md, API_REFERENCE.md, AUDIT_CHAIN.md, ADAPTERS.md, SECURITY.md resolve after the foundation and specialty PRs (#8, #9, #10, #11) land.
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
1 participant
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
Replaces the old QUICKSTART (which assumed a hosted Vyrox dashboard that doesn't exist yet) with a real ten-minute OSS path:
git clone→ built proxy → signed/executerequest → inspected audit JSONL.Replaces the two-line CONTRIBUTING with an actual workflow document.
QUICKSTART scope
vyrox-proxy,vyrox-simulator,vyrox-docs/executeAUDIT_CHAIN.mdCONTRIBUTING scope
Depends on / merges after
#8 foundation rewrite. Cross-refs to
ARCHITECTURE.md,AUDIT_CHAIN.md,ADAPTERS.md,SECURITY.mdresolve once the foundation and the specialty PRs (#9, #10) land.Test plan