arrow-meta icon indicating copy to clipboard operation
arrow-meta copied to clipboard
verified publisher icon arrow-kt

Docs template

Open JorgeCastilloPrz opened this issue 5 years ago • 0 comments

Meta documentation needs a format proposal so all features are documented in the same way. This is the initial proposal:

  1. Feature
  • Getting started
  • Examples
  1. Cli Error Messages UX
  2. IDE editor interaction
  3. IDE configuration
  4. IDE diagrams and visualization
  5. IDE Deep system integration (usage, search, ..)

We will work on this as soon as the initial feature we are polishing (@coercion) is ready both in compiler and UI sides. Coercion will be used as the proof of concept for the template. Once agreed we'll replicate that format to the rest of the features.

JorgeCastilloPrz avatar Apr 21 '20 13:04 JorgeCastilloPrz