Add collaboration docs scaffold with module index and issue/todo split#1
Draft
Add collaboration docs scaffold with module index and issue/todo split#1
Conversation
Co-authored-by: apehex <17317183+apehex@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add common documentation for LLM agents
Add collaboration docs scaffold with module index and issue/todo split
Mar 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR introduces a shared, repo-local documentation baseline for LLM-assisted collaboration, with a consistent structure under
docs/. It also adds a dedicateddocs/sources/area to document package modules and clarifies the role ofissues.mdas a curated working subset distinct fromtodo.md.Documentation foundation (
docs/)agents.md(agent working guidelines)context.md(project/package/test layout)decisions.md(key process/design decisions)ideas.md(speculative directions)invariants.md(hard repository constraints)issues.md(curated selected issues)todo.md(concrete next actions)references.md(external links)primer.jj(Jinja collaboration primer)index.md(top-level docs/source/test map)Source documentation expansion (
docs/sources/)docs/sources/index.mdwith a factual module-level inventory of:caching.py,metrics.py,sampling.py,schedules.py, etc.)blocks,layers,maths,models, andshapingOperating model for issue tracking docs
issues.mdnow defines a curated-priority list for active focus.todo.mdremains the execution list for concrete next tasks.📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.