Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
mlaursen opened this issue Nov 16, 2020 · 0 comments
Milestone

Comments

@mlaursen
Copy link
Owner

mlaursen commented Nov 16, 2020

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 mlaursen added this to the v.Unknown milestone Jan 3, 2021
@mlaursen mlaursen modified the milestones: v.Unknown, v6.0.0 Jun 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant