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

# Introduction

![](/files/-LGemJUgxVh_TgnARzhz)

## How to write XOOPS Documentation using GitHub and GitBook

[**XOOPS**](https://xoops.org) was always known for a very good code, good architecture, and its modular approach, but we were never able to create good documentation.

With the recent technological advances, especially around GitHub, we believe we have now found tools that will help us to:

a) streamline the process and make it more efficient b) engage the community by leveraging the same "forking and submitting pull requests" process as they they user at the normal coding activities.

* [XOOPS & GitBook](/xoops-documentation-process/english/english/introduction.md)
* [Process requirements](/xoops-documentation-process/english/english/process-requirements.md)
* [Process Workflow](/xoops-documentation-process/english/english/process-tools.md)
* [Documentation Standards](/xoops-documentation-process/english/english/documentation-standards.md)
* [XOOPS Docs Starter-Kit](/xoops-documentation-process/english/english/xoops-docs-starter-kit.md)
* [Credits](/xoops-documentation-process/english/english/credits.md)
* [About XOOPS CMS](/xoops-documentation-process/english/english/about-xoops.md)

## License:

[![Creative Commons License](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-nc-sa/4.0/)\
Unless specified, this content is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/).

All derivative works are to be attributed to XOOPS Project ( [www.xoops.org](https://xoops.org) )


---

# 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:

```
GET https://xoops.gitbook.io/xoops-documentation-process/master.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.