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

Sort & Group components #1

Open
5 tasks
znck opened this issue Aug 3, 2020 · 2 comments
Open
5 tasks

Sort & Group components #1

znck opened this issue Aug 3, 2020 · 2 comments

Comments

@znck
Copy link
Collaborator

znck commented Aug 3, 2020

  • Create sections of components
  • Assign components to sections
    • Can a component be assigned multiple sections?
  • Navigate to the section route
    • What do we see on the section page?
@znck
Copy link
Collaborator Author

znck commented Aug 3, 2020

Does using directory name as the group name make sense? Should we create a group tree or use file's parent directory as group?

@elevatebart
Copy link
Collaborator

elevatebart commented Aug 3, 2020

Does using directory name as the group name make sense?

It does makes sense to a lot of my users.
But I know that some user prefer a flat structure for their components.
I would see the directory name be a great default grouping.

Should we create a group tree or use file's parent directory as group?

As a user I would like the directory structure to be the default grouping.
Then a few options in the config file:

  • flat: boolean should turn the list completely flat ignoring the folder structure
  • sections: Array<Sections> similar to the sections config in styleguidist where grouping is entirely manual using globs & ignores

elevatebart added a commit that referenced this issue Nov 25, 2020
elevatebart added a commit that referenced this issue Nov 30, 2020
* integrate vue-docgen-api in preview

* chore: update deps

* feat: add collapse of left panel

* fix: remove weird margin at bottom of body

* feat: first rendering of docs

* rename docs folder to "docsParts"

* documentation release #1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants