docs: refresh README, user guide, architecture, and templates for v1.6#7
Merged
Merged
Conversation
Bring all user-facing docs in line with the v1.6 app shape after the Tags / Provisioning Builder / Build Payload / first-run setup passes. - README: add "what Runway intentionally does not do", surface first-run setup, sync status pill, Tags view, Build Payload, EntityPicker, and single-device destructive actions; replace stale "1.0 Readiness" with a tenant testing warning. - docs/user-guide: end-to-end rewrite with first-run setup, sync pill, Tags view + drawer, Provisioning Builder + Build Payload availability states, EntityPicker primary-user search, tabbed device detail with ?tab= deep-links, tenant testing workflow. Drop "Confirm destructive actions toggle", "enter user object ID", and "raw GUID" instructions. - docs/architecture: document app-only vs delegated split, first-run completion criteria, sync status source of truth, raw_graph_assignment and tag_config cleanup, Build Payload data flow, and a non-goals list. - docs/live-testing-checklist: add first-run setup, sync pill, Tags, Build Payload, EntityPicker, and 1.5 -> 1.6 rollback notes. - docs/security-report: clarify destructive confirmations are always enforced, idempotency keys, EntityPicker, and snapshot retention. - docs/runway-overview: drop fabricated test/bundle benchmarks. - CONTRIBUTING: branch/PR rules and CHANGELOG discipline section. - .github: PR template gains a Risks section; bug_report adds new affected-surface options for Setup, Tags, Provisioning Builder, and Build Payload.
Summarise the v1.6 doc/repo polish under [Unreleased] without bumping the package version.
Trim the wall-of-text up top and add lightweight structure without pushing into marketing-flashy territory: - Lead with the one-line tagline above the badges, add a Local-first badge alongside the existing CI/MIT/Windows ones. - Add a compact "At a glance" facts table (platform, data sources, residency, auth, egress, targeting, out-of-scope) right after the intro. - Add a small inline "Jump to" link row to the most-used sections. - Collapse the long .env reference, ConfigMgr signal table, the two Graph permission lists, the full npm scripts table, and the project layout tree into <details> blocks so the page scans quickly. - Promote the most-used npm scripts (dev, check, build, tauri:dev, tauri:build) into a short top-level table; keep the full list inside the collapsible. - Drop the "v1.0" SCCM phrasing now that the app has shipped past 1.0.
- README .env reference now points to .env.example for the full annotated template, drops the engine tunables that moved to Settings in 1.5, and adds LOG_LEVEL + a reminder that DB-backed Settings take precedence over env overrides. - runway-overview "take action" line replaces the stale "bulk-act across the whole queue" wording with the current single-device destructive set + bulk-restricted-to-sync/reboot/rotate-laps reality.
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
Documentation and repo hygiene pass to align user-facing docs with the
v1.6 Runway app (first-run setup, sync status pill, Tags view + drawer,
Provisioning Builder, Build Payload availability states, EntityPicker
for Change Primary User, single-device destructive actions, deep-linked
tabbed device detail). No product features added; no package version
bump; no
mainpush.Docs changed
warning; expanded "What it does" with first-run setup, sync pill,
Tags, Provisioning Builder, Build Payload, EntityPicker, centralised
portal links, custom-rule preview; added "What it intentionally does
not do".
setup, sync status pill, Tags view + drawer, Provisioning Builder
workflow, Build Payload panel + availability states, EntityPicker
primary-user search, tabbed device detail (Identity/Targeting/
Enrollment/Drift/Operate/History) with
?tab=deep-links, tenanttesting workflow.
completion criteria, sync status source of truth,
tag_configcleanupnotes,
raw_graph_assignment, Build Payload data flow, and a non-goalssection.
Provisioning Builder + Build Payload, EntityPicker, and 1.5 → 1.6
rollback notes.
enforced, idempotency keys, EntityPicker, snapshot retention.
size claims.
discipline section.
expanded affected-surface options for Setup, Sync pill, Tags,
Provisioning Builder, Build Payload.
[Unreleased]Documentation entry.Stale docs removed
destructive confirmations are always enforced).
User (replaced by EntityPicker search by display name, UPN, or mail).
side drawer; Settings only handles JSON import/export).
numbers shift; user guide now indexes by section title).
docs/runway-overview.md.Validation
npm run lint✅ (no errors)npm run typecheck✅npm run test✅ 319 unit + api tests pass (31 files)npm run test:e2e✅ 30 e2e tests pass (4 files)npm run build✅ client + server bundles built cleanpackage.jsonversion unchanged (still1.6.0)Section 9,Confirm destructive,user object ID,raw GUID,never-disable-confirmations) — onlyhits in CHANGELOG entries (describing the removals) and in new docs
describing that raw GUIDs are no longer required.
Screenshots
No screenshots updated — current docs do not embed UI screenshots and
the repo does not have an automated screenshot tooling convention. If a
screenshot pass is desired for the user guide, recommend doing it as a
follow-up against a frozen build so screenshots stay in sync with
release artifacts.
Risks
schema, or behaviour impact.
updated; reviewers should still spot-check
docs/user-guide.mdnavigation links if they spot an anchor renamed.
Remaining decisions
docs/runway-overview.mdif its contentis fully covered by README + user guide.