docs: make README ultra-lean - #347
Merged
Merged
Conversation
amilandi
force-pushed
the
amilandin/readme-ultra-lean
branch
from
September 26, 2026 01:05
501047e to
723e283
Compare
Per Sam's ask, cut the top-level README down to just the ESS ADK One-Shot Installer description + the Windows and macOS install commands, and point at setup/README.md for everything else. Also preserves links to SUPPORT / SECURITY / CONTRIBUTING / LICENSE so the repo-root file still surfaces the mandatory OSS pointers. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 70ddf006-7f8d-48e7-9afa-3fbae73b3864
amilandi
force-pushed
the
amilandin/readme-ultra-lean
branch
from
September 26, 2026 01:08
723e283 to
f1d6d97
Compare
Contributor
|
Local review complete: no actionable findings. The streamlined root README points to the existing setup guide and maker-kit quick start, and its Markdown formatting checks pass. The branch is fresh against |
nkemms
approved these changes
Sep 26, 2026
nkemms
left a comment
nkemms
left a comment
Contributor
There was a problem hiding this comment.
Reviewed locally; no actionable findings.
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
2 participants
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.
Per saengland's ask on Teams (Sept 25): make the top-level README's setup guidance extremely concise. Only the setup section is trimmed; the rest of the README is preserved.
Scope
## Getting startedblock only — replaced the setup-paths comparison table and the "How to open ess-maker-skills as a workspace" / "I opened the wrong folder" walkthroughs with two one-line install commands (Windows PowerShell + macOS bash) and a pointer tosetup/README.mdfor Codespaces / FlightCheck-only / Maker vs Developer mode selection, plus a pointer tosolutions/ess-maker-skills/README.md#quick-startfor the manual clone path.Diff
+10 / -59 on
README.md. Net delta: 49 lines removed, all inside the## Getting startedblock.Why
The one-shot installer handles workspace-folder selection automatically, so the "open the right folder" walkthrough is no longer needed on the surface page for the recommended path. Anyone who prefers to clone manually has a one-click link to the maker kit's Quick Start.