# Documentation maintenance

### GOOD PRACTISES

* Use links instead of embedding hardcoded things
* Do not merge any PR without updating the documentation first (add the Gitbook's PR link in the PR of Github)
* Follow the same structure / standards as in the rest of the sections, clients, protocol, etc...

### TODO's

* [ ] Add the links to the examples
* [ ] Replace all hardcoded code with examples versioned on Github
* [ ] Automate the Typedoc generation by an action so that it is generated automatically with each merge to master


---

# 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://xchainjs.gitbook.io/xchainjs/documentation-maintenance.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.
