> For the complete documentation index, see [llms.txt](https://docs.shiftiq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shiftiq.com/contributors/implementation/reference.md).

# Internal code reference

## Contributor API vs Developer API

We make a clear distinction between the **Developer** API and the **Contributor** API, because it clarifies a fundamental difference in audience and purpose:

* Developer APIs focus on consumption and integration patterns, emphasizing stability, usability, and external use cases
* Contributor APIs document implementation details, internal architecture decisions, and modification workflows that enable effective contribution to the codebase.

Clearly, every software system has a "Contributor API", so it is unfortunate there is no standard industry term for this. The term "Contributor API" is especially well-suited to an open-source context where internal team members are indeed contributors, and the term aligns perfectly with established terminology for collaboration in both public and private GitHub repositories.

By adopting this convention, we make it immediately clear whether documentation is intended for those *integrating with* the system versus those *building on* the system. In turn, this helps reduce confusion and ensures contributors can easily locate the technical depth they need for internal development work.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Contributor API</strong></td><td>Internal interface for team members modifying and maintaining the system</td><td><a href="https://docfx.shiftiq.com/">https://docfx.shiftiq.com/</a></td></tr><tr><td><strong>Developer API</strong></td><td>External public interface for developers and integrators extending the system</td><td><a href="https://docs.shiftiq.com/developers/api-v2/introduction">https://docs.shiftiq.com/developers/api-v2/introduction</a></td></tr></tbody></table>


---

# 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.shiftiq.com/contributors/implementation/reference.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.
