> 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/conventions.md). # Conventions - [API conventions](https://docs.shiftiq.com/contributors/conventions/api-conventions.md) - [Architecture](https://docs.shiftiq.com/contributors/conventions/architecture.md): How InSite source code is organized into the God, Shift iQ, and General systems, and the future-state architecture we are working toward - [Database naming conventions](https://docs.shiftiq.com/contributors/conventions/database-naming-conventions.md): Naming conventions to help every contributor speak the same schema - [Folder structure and project names](https://docs.shiftiq.com/contributors/conventions/folder-structure-and-project-names.md): Guidelines for the layout and structure of a scalable, readable codebase - [Git commits](https://docs.shiftiq.com/contributors/conventions/git-commits.md): Conventions for commit messages - [Git branches](https://docs.shiftiq.com/contributors/conventions/git-branches.md): The purpose of each branch in the InSite Code repository, and the naming conventions for each branch - [Git pull requests](https://docs.shiftiq.com/contributors/conventions/git-pull-requests.md): How to implement, submit, and review code changes through Git pull requests and the GitHub review process - [Introduction](https://docs.shiftiq.com/contributors/conventions/introduction.md): Naming and URL conventions for primary and secondary API endpoints, queries, commands, and the general-purpose React UI endpoints - [Migrate CRUD to CQRS+ES](https://docs.shiftiq.com/contributors/conventions/migrate-crud-to-cqrs-es.md): Concepts and a step-by-step pattern for migrating a CRUD entity to a CQRS+ES Timeline aggregate - [Obsolete timeline changes](https://docs.shiftiq.com/contributors/conventions/obsolete-timeline-changes.md): How to handle obsolete timeline Changes - either ignoring them or upgrading them to a newer version - [README files](https://docs.shiftiq.com/contributors/conventions/readme-files.md): README first: explain what it is, what it does, and how to use it - [Source code](https://docs.shiftiq.com/contributors/conventions/source-code.md): Naming and coding conventions for InSite source code, including telemetry, options and settings, lines of code, regions, TypeScript, and third-party code - [Style guide](https://docs.shiftiq.com/contributors/conventions/style-guide.md): Conventions for a consistent, unified approach to layout and style throughout the user interface - [Task list comment tokens](https://docs.shiftiq.com/contributors/conventions/task-list-comment-tokens.md): Streamline development by highlighting actionable items in code, improving visibility, collaboration, and maintainability - [Terminology](https://docs.shiftiq.com/contributors/conventions/terminology.md): Key terms in our lexicon for designing, building, and managing the software, including libraries, namespaces, entities, and URLs - [Version numbers](https://docs.shiftiq.com/contributors/conventions/version-numbers.md): This convention guarantees unique version numbers for every build - [Video recommendations](https://docs.shiftiq.com/contributors/conventions/video-recommendations.md): Just a few of the favorite best-practice videos recommended by our contributors --- # 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.shiftiq.com/contributors/conventions.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.