> For the complete documentation index, see [llms.txt](https://bing-rover.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bing-rover.gitbook.io/docs/software/readme.md). # Software Documentation These pages document the Software Team's layout, structure, and best practices. Specifically, these pages will walk you through the structure of the rover, where to find code, and where to find documentation for the code. **These docs describe the high-level design and do not describe the exact API, functions, or lines of code.** Code should be documented in-source using comments that start with `///` , which will then be picked up by our tooling ([Doxygen](https://www.doxygen.nl/) and [DartDocs](https://dart.dev/language/comments#documentation-comments)) and extracted elsewhere. See the page on [code documentation](/docs/software/writing-code/documenting-code.md) for more information. Our rover is a very complex system, which means our code has the complexity to match. Complexity means layers of abstraction and delegation of responsibilities. Even if we *could* have a single million-line file, our code needs to run on multiple devices in different environments, so we need to choose the best platform, language, framework, and tools for each scenario. The [Overview](/docs/software/overview/architecture.md) section provides high-level details of the entire codebase, with later sections providing more details. Please read the entire Overview section to learn about the different parts of the rover, and, using that information, read through as much of the relevant docs for your tasks as possible. This will help give you a better context when writing code and help you ask more focused questions that go beyond "how does this work?" --- # 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://bing-rover.gitbook.io/docs/software/readme.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.