Skip to content

Inference Documentation Restructure #257

Description

@nikomatsakis

Inference Documentation Restructure

Status: In Progress

Current Understanding

Improve type inference documentation in dada-ir-sym by restructuring to be example-driven, starting with simple concrete examples that introduce concepts gradually.

Next Steps

  • Finalize example selection and ordering
  • Rewrite main type_inference.md with example-first approach
  • Update cross-references in existing documentation
  • Consider splitting into multiple files (overview, examples, reference)

Open Questions

  • Should we have more examples or fewer?
  • How much detail in the initial examples vs deep dives?
  • Should examples build on each other or be independent?

Context

Current documentation is comprehensive but hard to follow - jumps into architecture without concrete examples. Proposed approach uses progressive examples:

  1. Simple variable inference
  2. Function calls with bidirectional flow
  3. Permission inference
  4. Concurrent checking

Created constraint_system_deep_dive.md covering direction parameters, bound representation, inference completion detection, and constraint propagation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    ai-managedAI can update OP and add commentsdocumentationDocumentation improvementstracking-issueOngoing work item with living documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions