Skip to content

docs: make install and login easier for newcomers - #340

Open
AetherAI3 wants to merge 2 commits into
mainfrom
docs/readme-newcomer-onboarding
Open

AetherAI3 wants to merge 2 commits into
mainfrom
docs/readme-newcomer-onboarding

Conversation

@AetherAI3

@AetherAI3 AetherAI3 commented Oct 17, 2026 •

Copy link
Copy Markdown
Owner

Why

Newcomers had to find installation below the demo and feature table, infer what browser login does, and distinguish interactive chat from tasks that operate on their checkout. The authentication reference still described the old token-paste flow.

What changed

  • Put install → browser approval → first coding task at the top, with copyable commands, Node download links, version checks, and SSH/login recovery.
  • Explain the npm package/command names and the pipx launcher's prerequisites and aether-agent entrypoint.
  • Clarify hosted chat versus local checkout tasks; order Ollama setup after downloading and selecting a model.
  • Coordinate live badges, add direct onboarding navigation, and group advanced controls in expandable sections.
  • Label source features separately from published packages and correct the handwritten authentication reference.

Verification

  • Full npm test: 3,466 passed, 16 skipped, 0 failed (3,482 total).
  • npm run lint / typecheck, documentation generation check, production/package verification, and npm pack --dry-run passed.
  • Release truth: 12/12 passed, including live npm registry evidence.
  • Checked 54 relative links/anchors and image paths; inspected GitHub's rendered README, navigation, and loaded badges/assets.
  • Cross-checked onboarding against source and the published npm tarball. Generated catalogue contents are preserved.

Scope and limits

Only README.md and the handwritten auth section of COMMANDS.md change.

npm run smoke remains unsuccessful in this executor: public example.com DNS resolution fails (2 passed, 4 skipped, 1 failed). Hosted-model and Ollama checks were skipped because those services were not configured. No live login approval or model task was performed.

Hosted checks on a94a0c3: CI and CodeQL failed before any job steps ran. Aether Hosted Build & Test returned neutral because its approved executor image was unavailable. These remote checks are not satisfied; local validation does not replace them.

This branch has not been deployed

No deployments
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