Clean up documentation - Githubissues

canjs / can-component

Custom elements and widgets

https://canjs.com/doc/can-component.html

MIT License

8 stars 8 forks source link

Clean up documentation #301

Closed phillipskevin closed 5 years ago

phillipskevin commented 6 years ago

As part of https://github.com/canjs/canjs/issues/4116, we also might want to make some docs less prominent by either hiding them or moving them to a deprecated section:

[ ] events
[ ] helpers
[ ] viewModel
[ ] leakScope ?

Also, we should

[ ] move beforeremove under lifecycle hooks

And probably

[ ] support a connectedCallback directly on a component's prototype
[ ] support a beforeRemove directly on a component's prototype

phillipskevin commented 6 years ago

@justinbmeyer do you think these things should be deprecated officially? Meaning we'll remove them in the next major.

phillipskevin commented 6 years ago

I think the best way to do this is to move these into mixins and then move the current docs to a "legacy" section or something that links to the docs of the mixins.

I'm going to investigate what it will take to make that work.

chasenlehara commented 5 years ago

Closing this because the docs have been moved to a new “deprecated” section.