dendron-site icon indicating copy to clipboard operation
dendron-site copied to clipboard

dendron.topic.publish.cli: example instructions are confusing

Open l2dy opened this issue 2 years ago • 1 comments

https://github.com/dendronhq/dendron-site/pull/310 makes the Publish CLI page confusing as if an npx one-liner would work without context in the referenced page.

npx would not know that dendron is from @dendronhq/dendron-cli if it's not installed.

l2dy avatar Dec 21 '21 17:12 l2dy

Agreed. Suggestion as mentioned on https://github.com/dendronhq/dendron-site/pull/310#issuecomment-985083462

Better would be to document behavior in both cases when a user does - npx install @dendronhq/dendron-cli or npx install -g @dendronhq/dendron-cli

I think #310 is causing inconsistencies on publish > cook > github and cli pages as well.

hrmnjt avatar Dec 21 '21 21:12 hrmnjt