> For the complete documentation index, see [llms.txt](https://docs.tomorrowx.com/cap/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tomorrowx.com/cap/best-practices/comments-and-descriptions.md).

# Comments & Descriptions

It is good practice to comment and describe rules, rule sets and repositories in Tomorrow Software. Comments and descriptions help explain the purpose of the design and why it was designed in the specific manner. It also makes life easier for the next rule writer, reducing the overhead associated with association and learning.

## Rule Commenting <a href="#toc63157199" id="toc63157199"></a>

Each rule should be commented with an appropriate description that explains what it does. Rule comments could begin with a verb that briefly describes the activity.

![Rules Commenting](/files/WmcczPr2B7XBhcfBcaCr)

Comments can also be added in the rule set page as a floating text box, with the “Comment” rule. This can be used to describe the purpose of specific rule activity on the page, or detailed technical information regarding the rule set.

![Comment floating text box](/files/ZbwX4i47f5KmTdRPQQ5t)

## Rule set and repository descriptions <a href="#toc63157200" id="toc63157200"></a>

Rule sets and repositories should be given an appropriate description as to help understand their purpose.

Rule set example:

![Rule Info tab](/files/IHl23HpldfbEuC73w5In)

Repository example:

![Repository Description example](/files/QP1dvr7EEZh64yP6ibgd)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.tomorrowx.com/cap/best-practices/comments-and-descriptions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
