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

Generated site: introduce sidebar/detail view #35

Open
fahad19 opened this issue Apr 15, 2023 · 2 comments
Open

Generated site: introduce sidebar/detail view #35

fahad19 opened this issue Apr 15, 2023 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers ui

Comments

@fahad19
Copy link
Member

fahad19 commented Apr 15, 2023

Currently

There's top navigation that has links to Feature, Segments, Attributes, and History.

Docs: https://featurevisor.com/docs/site/

Problem

It does not quickly give you an overview of the total number of Features, Segments, and Attributes that exist in the Featurevisor project.

Solution

We can change the UI to be sidebar-based, where top nav becomes sidebar nav.

And the links in sidebar can also show total number of items, like:

  • Features (10)
  • Segments(4)
  • Attributes(5)
  • History

Technical notes

More info: https://featurevisor.com/docs/site/

All components found here: https://github.com/fahad19/featurevisor/tree/main/packages/site/src/components

Local development tips

$ npm ci
$ npm run bootstrap

Make changes in packages/site, then do:

$ (cd ./packages/site && npm run build)

See the changes in example app:

$ (cd ./examples/example-1 && npm start)
@fahad19 fahad19 added enhancement New feature or request ui good first issue Good for newcomers labels Apr 15, 2023
@1e9y
Copy link
Contributor

1e9y commented Aug 25, 2023

Do you have any examples that illustrates your proposal? Maybe some other documentation site that has sidebar-based UI?

@fahad19
Copy link
Member Author

fahad19 commented Aug 27, 2023

@1e9y: this can be a good example of the sidebar/detail view https://tailwindui.com/components/application-ui/navigation/sidebar-navigation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers ui
Projects
None yet
Development

No branches or pull requests

2 participants