Skip to content

docs(cli): document current publish workflow - #3674

Merged
jrusso1020 merged 1 commit into
mainfrom
docs/cli-publish-readme-current
Sep 4, 2026
Merged

docs(cli): document current publish workflow#3674
jrusso1020 merged 1 commit into
mainfrom
docs/cli-publish-readme-current

Conversation

@jrusso1020

Copy link
Copy Markdown
Collaborator

The CLI package README omits publish, so readers cannot discover hosted sharing or its authentication and visibility options there. Add current directory examples, --public/--yes guidance, signed-in update/team-space behavior, and a link to the full reference. Explain that a missing or inaccessible update target can create a new project.

Refreshes #1950 with credit to @tianma-if in the signed commit.

Validation: checked current command and upload handling; parsed all six documented argument forms and generated help from the current Citty schema without running the upload handler; verified the documentation link; formatting, diff checks, and required commit hooks passed. No project was uploaded.

Refresh the README guidance from #1950 for current auth, visibility and updates.

Co-authored-by: yoma <yingwaizhiying@gmail.com>

@miguel-heygen miguel-heygen left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed f6b43bb94104811b87acf71fcb714cfa5989e711.

packages/cli/README.md:74 documents the existing publish workflow accurately, including claimed-project visibility and the new-project fallback when an update target is unavailable. Traced the current argument schema, authentication gate, staged/direct upload metadata, claim-token URL and printed status paths. Contributor credit to @tianma-if is preserved in the commit.

No findings. Documentation review only; no live upload or claim was performed.

No prior reviews or comments were present at precheck. CI has no failed checks at this check, but pending checks remain; this approval is on code/documentation merits and is not a CI-complete or merge-ready claim.

— Magi

Verdict: APPROVE
Reasoning: The change matches the current implementation and no blocking regression was found within the stated verification scope. Required CI must still finish successfully.

@jrusso1020
jrusso1020 merged commit 44208ce into main Sep 4, 2026
49 checks passed
@jrusso1020
jrusso1020 deleted the docs/cli-publish-readme-current branch September 4, 2026 23:52
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.

2 participants