react-md icon indicating copy to clipboard operation
react-md copied to clipboard

Update documentation site navigation and search results to be component based instead of package based

Open mlaursen opened this issue 3 years ago • 0 comments

Reasoning

  • people normally search by component instead of package name -- it doesn't really matter where the component comes from
  • my search implementation is really bad and it isn't even possible to find GridList or Grid components due to the bad indexer results
  • the form package has too many components inside and the demo page is too big (especially with the addition of sliders)

Thoughts

Maybe create a Components tree item like in v1 which does a component-level demo and remove the packages/[name]/demos from the packages section. So the Packages tree item would contain:

  • a list of all packages (like today)

where each package contains:

  • Installation
  • Sass Doc
  • Changelog

The Components tree item would just be a list of all components in alphanumeric order linking directly to the demos for that component. Eventually might also move the Component API into here once I figure out how to get something useful from Typedoc or a new tool.

mlaursen avatar Nov 16 '20 01:11 mlaursen