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

slot CLI Documentation #261

Open
juandiegocv27 opened this issue May 1, 2024 · 4 comments
Open

slot CLI Documentation #261

juandiegocv27 opened this issue May 1, 2024 · 4 comments
Assignees

Comments

@juandiegocv27
Copy link

juandiegocv27 commented May 1, 2024

The current CLI documentation for 'Slot' lacks the comprehensive detail found in the 'Sozo/Katana' guides. We aim to bring 'Slot' up to par by clearly documenting all commands, arguments, options, and providing concise examples. #202

@juandiegocv27
Copy link
Author

@milancermak @ptisserand @broody @thiscaspar I just created the issue, assign it to me

@kariy
Copy link
Member

kariy commented May 1, 2024

assigned :)

@juandiegocv27
Copy link
Author

juandiegocv27 commented May 1, 2024

assigned :)

thank u, I tried to contact to you from discord but I dont fin the the username :( (My discord user is juglitott, and in telegram juandiegocar), and about the documentation, could you send me more about the issue and the part in the code to cofigure, I just saw there's maybe a spot in the the code of docs about Katana, maybe I need to configure the Katana.md? @kariy

@kariy kariy changed the title Spinning a Katana up on slot slot CLI Documentation May 2, 2024
@kariy
Copy link
Member

kariy commented May 2, 2024

thank u, I tried to contact to you from discord but I dont fin the the username :( (My discord user is juglitott, and in telegram juandiegocar),

hmm, i cant find you username either. if you're in the Dojo discord server, you can find my name (same pfp) under the 'sensei' role.

and about the documentation, could you send me more about the issue and the part in the code to cofigure,

For starters, you can take a look at all commands that slot has. You can learn about them by playing around with the slot CLI tool, and can learn more from reading the source code itself. We need to document the commands, arguments, option flags, etc.

You can just follow the pages structure for sozo, where each command and shared option is placed in their own .md/.mdx file.

I just saw there's maybe a spot in the the code of docs about Katana, maybe I need to configure the Katana.md? @kariy

You don't have to do change anything under the Katana section, only Slot.

juandiegocv27 pushed a commit to juandiegocv27/Documentation_Dojo_Book that referenced this issue May 13, 2024
juandiegocv27 pushed a commit to juandiegocv27/Documentation_Dojo_Book that referenced this issue May 13, 2024
juandiegocv27 pushed a commit to juandiegocv27/Documentation_Dojo_Book that referenced this issue May 29, 2024
juandiegocv27 pushed a commit to juandiegocv27/Documentation_Dojo_Book that referenced this issue May 29, 2024
juandiegocv27 pushed a commit to juandiegocv27/Documentation_Dojo_Book that referenced this issue Jun 4, 2024
juandiegocv27 pushed a commit to juandiegocv27/Documentation_Dojo_Book that referenced this issue Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

2 participants