Docs Meeting Notes: DT and .d.ts docs

[orta]

Docs review

• .d.ts files + DT docs

Questions to answer

• What types of example modules do we want to show?
• Should we migrate DT docs into the TS site
  • If so, at what level of abstraction?
• What is the relationship between DT docs and DTS docs

• Date: July 1st, 2020
• Agenda
  1. Review mixin docs (PR) from last meeting 5-10min
  2. What do we have on DT + .d.ts today 10min
  3. Example Modules 10min
  4. What should DT docs look like? 10min
  5. Open discussion: ~

Mixin Notes

Current DT + .d.ts docs

• http://definitelytyped.org
• https://microsoft.github.io/TypeSearch/

Potentially missing

• Notes about downlevel-dts
• How to write tests/lint .d.ts files
  • dtslint has some good docs on how to do this

Example Modules

• Global Modifying Module
• Global Plugin
• Module
• Plugin via imports
• Class
• Function

Action Items

• Library Structures:
  • Globals are prioritised in docs today and ES Modules are hidden at the bottom, should be flipped
  • CommonJS lib and want to export util types (using namespaces)