# Information

After doing your utmost best to solve your issue, if you still can't succeed, it's time to ask for assistance.

{% hint style="info" %}
Not sure where to ask for peer-help? See the [Resources page](/syntask/resources.md).
{% endhint %}

Outlined below are some key points to keep in mind, and the details you should provide.

This project is your project, and thus your responsibility. People shouldn't have to fight to get information out of you. Don't create a post and just say you "need help" and then wait for someone.

People can't read minds or see your files. If you aren't going to help them help you, they can't help you. You need to provide information, otherwise people won't know how to help you.

***

## Code

Provide relevant code. People won't be able to point out issues in your code if they can't see the code.

Looking for issues in code is already like looking for a needle in a haystack. There's no need to add more hay; you don't need to send the entire file, only the section(s) relevant to your issue(s).

### Code blocks

Make sure to format your code in a code block to make the code and indentation easy to read, and prevent markdown (italics, bold, etc.) from special symbols. Simply put 1 or 3 backticks (`` ` ``) before and after your code.

Three backticks will result in a full code block;

\`\`\`\
Full code block\
\`\`\`

{% code overflow="wrap" lineNumbers="true" %}

```python
Full code block
```

{% endcode %}

And one backtick will create a single-line code block;

\`Single-line code block\`

`Single-line code block`

***

## Context

Describe what your code is supposed to do, and how and when it fails.

Simply stating your code "has an issue" or "doesn't work" doesn't provide any helpful information. This does not tell anyone what the issue actually is, or when or where it happens. People can already deduce something's wrong, that's why you're asking for help! You need to elaborate past "my code doesn't work". Provide a concise account of what you're trying to code, and what parts break and when they break.

{% hint style="info" %}
If you aren't sure how to describe your issue, here are some generic prompts:

* Does your code have errors when parsed?
* ﻿﻿What tasks does your code fail to do?
* ﻿﻿Are there unintended side effects of your code?
  {% endhint %}

If you have error messages, also provide those. Again, saying your code "has an error" is not very informative. Error messages contain plenty of helpful information; the type of error you have, and the line it occurs. In fact, by reading the error message, you might be able to figure out a solution on your own!

***

## Software

Let people know what server, Skript, and addon versions you are using (if applicable).

Skript and addon versions are heavily dependent on your server version, so if your server is on 1.12 or 1.8, you may not be able to use certain addons or versions with certain features.

Letting others know what addons you have can also be a good idea. This will let people know if you are missing a needed addon, or potentially have an outdated addon that could be interfering.

{% hint style="info" %}
See the [Outdated Addons page](/syntask/outdated-addons.md) for a list of unnecessary addons and alternatives.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://x8ight.gitbook.io/syntask/issues/peer-help/information.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
