Skip to content

docs: reconcile installation and MVP status - #93

Merged
dDevAhmed merged 2 commits into
mainfrom
docs/cli-040-installation-reconciliation
Sep 16, 2026
Merged

dDevAhmed merged 2 commits into
mainfrom
docs/cli-040-installation-reconciliation

Conversation

@dDevAhmed

@dDevAhmed dDevAhmed commented Sep 16, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Implements CLI-040 by reconciling public-facing installation and repository status documentation with the post-CLI-038 implementation state.

Fixes

  • removes foundation-era claims that the package/repository is still private or only planned;
  • distinguishes implemented protected release automation from the still-pending first npm publication;
  • records REL-001 as the external npm/Trusted Publishing blocker;
  • removes literal escaped-newline rendering defects from Installation and README;
  • documents source checkout and optional local npm link evaluation without pretending registry publication already exists;
  • updates README command status from Planned to Implemented;
  • updates project status to implemented MVP / pre-v1 stabilization;
  • keeps Testnet-only deployment and post-v1 exclusions explicit.

Closes #91

Summary by CodeRabbit

  • Documentation
    • Updated the README to reflect the implemented 0.1.0 MVP, including available commands, project structure, validation, release automation, and MIT licensing.
    • Expanded installation guidance with supported Node.js/npm versions, platforms, contributor prerequisites, and local usage checks.
    • Documented optional npm linking and clarified that public npm installation remains unavailable pending release administration and security validation requirements.

@coderabbitai

coderabbitai Bot commented Sep 16, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 5e56a8ea-b674-44aa-8cd3-1badf7a94efd

📥 Commits

Reviewing files that changed from the base of the PR and between f1c15e9 and 1e311f4.

📒 Files selected for processing (2)
  • README.md
  • docs/guides/installation.md

📝 Walkthrough

Walkthrough

The documentation now describes the implemented 0.1.0 TypeScript/Node.js MVP, local installation and verification, release automation, supported tooling, and the pending REL-001 requirement for public npm publication.

Changes

Documentation state reconciliation

Layer / File(s) Summary
Implemented MVP documentation
README.md
README.md now describes implemented scaffolding, diagnostics, development, testing, commands, repository structure, release capabilities, version 0.1.0, and MIT licensing.
Installation and release documentation
docs/guides/installation.md
The installation guide now documents supported Node.js and npm versions, platforms, local CLI checks, optional linking, release security controls, and the unpublished npm state pending REL-001.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/cli-040-installation-reconciliation

Comment @coderabbitai help to get the list of available commands.

@dDevAhmed
dDevAhmed merged commit 959addc into main Sep 16, 2026
8 of 9 checks passed
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.

CLI-040 — Reconcile installation and publication documentation with current release state

1 participant