fast icon indicating copy to clipboard operation
fast copied to clipboard

docs: provide guidance on how patterns, practices, things to avoid

Open EisenbergEffect opened this issue 4 years ago • 3 comments

We should take more of our learnings from building components and experience and produce documentation that leads customers into the pit of success.

  • Project organization
  • File structure
  • Naming components/classes
  • How to think about state
  • TypeScript practices
  • Styling

EisenbergEffect avatar Feb 02 '21 21:02 EisenbergEffect

Agreed : ). Looking at FAST and finding it fascinating. Half of my curiosity is that it is, in the code, well-documented UI component behavior/state, independent of implementation.

adamcee avatar Oct 30 '21 01:10 adamcee

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Apr 16 '22 18:04 stale[bot]

Pure Javascript practices such as how to work without decorators in the various topics are also suggested. DI without decorators

send2vinnie avatar Sep 15 '22 07:09 send2vinnie

This is being addressed in the documentation update to @microsoft/fast-element v2, including a component library section for developers looking to publish their own component packages.

janechu avatar May 28 '24 19:05 janechu