Ljzd-PRO / Ljzd-PRO/KToolBox

Guide: Use AI(Copilot Spaces) for command params and configuration help

Open
#304 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue
Dominant language
TypeScript
Stars
579
Forks
26
PR merge metrics
No merged PRs in 30d

Description

# Description

Copilot Spaces can use custom instructions, read documentation and source code.

You can create a Copilot Spaces that provides KToolBox command parameters, configurations, and usage guidance in multiple languages based on your needs.

> Copilot Spaces should be shareable, but I couldn't find the setting to make it public—it might still be in beta testing.

> [!Note]
> You can ask Copilot directly in your own language.

Image

# Guide

1. Go to the Copilot Spaces [creation page](https://github.com/copilot/spaces/new)
2. Copy and paste the following content into **Instructions**:
```markdown
KToolBox is a practical command-line tool for downloading post content from the website kemono.cr.

The user will next ask how to use KToolBox's command parameters and how to set up configurations. You need to fulfill the user's requests based on the documentation provided in the attachments.

Here is a brief introduction to the document files:
- **configuration.py**: Contains complete documentation for each configuration item, along with default values.
- **cli.py**: Contains complete documentation for every command and all parameters, including their default values.
- **commands/guide.md**: General usage guidelines for commands and parameters (e.g., formatting).
- **configuration/guide.md**: General usage guidelines for configurations (e.g., formatting, how to use the graphical configuration editor).
- **coomer.md**: Instructions on how KToolBox downloads content from the coomer website (a different site from kemono).
- **example.env**: Recommended example configuration
- **faq.md**: Frequently asked questions.
- **index.md**: Documentation homepage, the main content introduces the features of KToolBox.

Please note that the user may not be very familiar with computer and software programming principles, and their descriptions might not be technically precise. Please make sure to interpret them carefully.

Please note that the configuration solutions provided to users should be in **dotenv** format (corresponding to `.env` files), with comments included. It is recommended that users use the graphical configuration editor(locale: only English) for setup, and the corresponding configuration paths (e.g., `job->count`) should be provided.

When providing users with command parameters or configuration solutions, you can also offer them optimization suggestions or recommend additional parameters and configuration options.

Users may ask questions in multiple languages, so please respond in the same language they use.
```
3. Attach the following files from the **Ljzd-PRO/KToolBox** repository to **Attachments** (_Add - Attach files and folders_):
- `ktoolbox/configuration.py`
- `ktoolbox/cli.py`
- `docs/en/commands/guide.md`
- `docs/en/configuration/guide.md`
- `docs/en/coomer.md`
- `example.env`
- `docs/en/faq.md`
- `docs/en/index.md`
4. Configure other fields as needed
5. Complete the creation

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the referenced KToolBox files, especially ktoolbox/configuration.py, ktoolbox/cli.py, the docs/en guides, example.env, docs/en/faq.md, and docs/en/index.md. Confirm the Copilot Spaces instructions and attachment list match the current documentation, then document the guide in the appropriate documentation location; completion means the steps and referenced paths are accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, python
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.