The mypyc user docs haven't seen much love for some time. It's worth going through and updating it to reflect the current state of affairs and be more comprehensive.

Updates & fixes

• Update the "Operator overloading" docs to include a list of unsupported dunders as most dunders are supported now
• typing.NamedTuple and enum.Enum are supported base classes
• IIRC attrs class decorators are now supported?

Additions

• Document the supported platforms (Python versions and system architectures)
• Document traits #583 (and in particular, clarify that traits can subclass concrete classes as long as the MRO stays linear)
• Document native integers and native floats
• Mention py-spy as a profiler that works with C extensions
• Mention that mypyc breaks introspection in various situations (no need to list them, but the user should be aware; see Compiled method is no longer a method #865)
• Document typing.Final as another way of annotating a class member as a class attribute
• Document which built-in functions can be patched (Cache builtins instead of always looking them up? #848)
• Document that nested classes are unsupported (for now?) (Support inner / nested classes #897)
• Document that conditional function and class definitions are unsupported (for now?) (A class definition nested in *anything* crashes mypyc with KeyError #864)
• Document primitive types are ops that aren't documented (at least bytes)

And later on when mypyc becomes beta software:

• Add a general guide/overview doc on getting a project compiled with mypyc (packaging and CD set up, and more)

UX

• Rework the landing page to have easy links to important pages, the MyST-Parser docs are a good example of this (or alternatively we can make the Introduction page the index page)

(other maintainers, feel free to edit this issue as you see fit!)