This repository contains design artifacts that define the architecture and design of cross-component interactions in the InstructLab project. The repo also serves as a home for technical policies that apply across all components.
Governance for InstructLab overall is documented in the community repository.
There is not (yet) a group that provides technical oversight across all of InstructLab. If such a group exists in the future, that group would assume ownership over the contents of this repository, with input from maintainers of all components within InstructLab.
In the meantime, ownership of this repository is shared collectively by the maintainers of all components within InstructLab. Required approval is loosely defined and depends on the scope of each proposal. In general, maintainers from all affected components should be sought for approval. The broader the scope or more controversial the topic, the more broad consensus is required to proceed. We expect the collective group of maintainers to use their best judgment to decide what constitutes appropriate approval on a case-by-case basis.
Design documents should be placed in docs/.
Files should be in Markdown format.
Diagrams are encouraged, but must be submitted in a format where they can be easily updated in the future as needed. Some options include:
- Mermaid
- Excalidraw ** Be sure to leave "Embed Scene" turned on when exporting the PNG.