Skip to content

Add collaboration docs scaffold with module index and issue/todo split#1

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/add-common-documentation
Draft

Add collaboration docs scaffold with module index and issue/todo split#1
Copilot wants to merge 2 commits intomainfrom
copilot/add-common-documentation

Conversation

Copy link

Copilot AI commented Mar 13, 2026

This PR introduces a shared, repo-local documentation baseline for LLM-assisted collaboration, with a consistent structure under docs/. It also adds a dedicated docs/sources/ area to document package modules and clarifies the role of issues.md as a curated working subset distinct from todo.md.

  • Documentation foundation (docs/)

    • Added first-draft core documents:
      • 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/)

    • Added docs/sources/index.md with a factual module-level inventory of:
      • top-level package modules (e.g. caching.py, metrics.py, sampling.py, schedules.py, etc.)
      • subpackage module files for blocks, layers, maths, models, and shaping
  • Operating model for issue tracking docs

    • issues.md now defines a curated-priority list for active focus.
    • todo.md remains the execution list for concrete next tasks.
    • This keeps GitHub Issues as the full system of record while enabling a concise in-repo working set.
docs/
├── agents.md
├── context.md
├── decisions.md
├── ideas.md
├── index.md
├── invariants.md
├── issues.md
├── primer.jj
├── references.md
├── todo.md
└── sources/
    └── index.md

📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

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
Copilot AI requested a review from apehex March 13, 2026 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants