TAMULib / weaver-components

Custom Web Components for the Weaver UI
MIT License
0 stars 1 forks source link

Components In-Code Documentation Improvements. #470

Closed kaladay closed 2 years ago

kaladay commented 2 years ago

The documentation for both Weaver and TAMU Library Components has consistency issues as a result of slightly different practices.

For example. in Weaver Components, everything has a "Default" but for TAMU Library Components everything instead has a "Basic".

Keep documentation in as few places as possible by adding more descriptions to the usage examples and/or the API/Specifications.

Then the Github wiki and the internal wiki need only point to the existing generated documentation.

Also, update the README files to be more descriptive.