docs: add workspace usage examples

[MaxBlack-dev]

Summary

This PR adds workspace usage examples to the npm publish documentation to address confusion about the proper syntax for publishing workspaces.

Related issue

Fixes #3543

What changed

• Added an "Examples" section to docs/lib/content/commands/npm-publish.md
• Included clear examples for:
  • Publishing the current directory
  • Publishing a specific workspace
  • Publishing multiple workspaces
  • Publishing all workspaces

Why this change is needed

Users were confused about the proper syntax for npm publish --workspace. The documentation had no examples demonstrating workspace usage, which made it difficult for users to understand how to use this feature.

Type of change

• Documentation improvement
• Bug fix
• New feature

Testing

• Documentation builds without errors
• Examples are syntactically correct and follow npm CLI conventions

Checklist

• Examples added to documentation
• Commit message follows Conventional Commits format
• References issue [BUG] Add command example for npm publish --workspace #3543 in commit message