Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add cli docs #498

Merged
merged 23 commits into from
Aug 7, 2024
Merged

add cli docs #498

merged 23 commits into from
Aug 7, 2024

Conversation

bishoy-at-pieces
Copy link
Contributor

No description provided.

Copy link

vercel bot commented Jul 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Aug 7, 2024 8:05pm

@@ -0,0 +1,395 @@
---
title: Pieces for Developers CLI Tool
Copy link
Contributor

Choose a reason for hiding this comment

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

I think in general, just a look at proper formatting should be followed.

Also we should add some assets - GIFs of using the CLI.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also please remove the Inconsistent capitalization: sometimes you use "Pieces OS" and other times "Pieces os"

And you can remove all the typos / grammatical errors

Copy link
Contributor

Choose a reason for hiding this comment

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

Also if you can follow the structure as recommended by @mason-at-pieces for other products

@@ -0,0 +1,395 @@
---
title: Pieces for Developers CLI Tool
Copy link
Contributor

Choose a reason for hiding this comment

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

Also if you can follow the structure as recommended by @mason-at-pieces for other products

@cole-at-pieces
Copy link
Contributor

"Pieces CLI Tool" should be proper naming convention. We can still mention it's a Python CLI tool, but any proper noun should be our name for it.

@bishoy-at-pieces
Copy link
Contributor Author

I think I will stick with Pieces CLI tool
should I capitalize the "t" in tool?

@cole-at-pieces
Copy link
Contributor

I think I will stick with Pieces CLI tool should I capitalize the "t" in tool?

Yes I'd do that

@bishoy-at-pieces
Copy link
Contributor Author

Thank you @cole-at-pieces
https://documentation-git-add-cli-agent-docs-pieces-for-developers.vercel.app/
check it and let me know if you have any other concerns
everything should be to Pieces CLI Tool

@mason-at-pieces
Copy link
Collaborator

@bishoy-at-pieces lets make sure that we are using h2's for subheadings. Seems like we skipped from h1 straight to h3

@mason-at-pieces mason-at-pieces merged commit cb56802 into main Aug 7, 2024
2 checks passed
@mason-at-pieces mason-at-pieces deleted the add-cli-agent-docs branch August 7, 2024 20:08
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.

Pieces CLI Docs CLI Docs
4 participants