> For the complete documentation index, see [llms.txt](https://xchainjs.gitbook.io/xchainjs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xchainjs.gitbook.io/xchainjs/documentation-maintenance.md).

# 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