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

Look at Docusaurus #57

Open
davidhund opened this issue Mar 13, 2018 · 3 comments
Open

Look at Docusaurus #57

davidhund opened this issue Mar 13, 2018 · 3 comments

Comments

@davidhund
Copy link
Owner

https://docusaurus.io/

@ran-dall
Copy link

@davidhund 👉 I feel like Docusaurus is meant for general documentation, as opposed to the focused and more elegant Pattern Generators currently on the list.

@davidhund
Copy link
Owner Author

@ran-dall You are right, it is. However, there is certainly some overlap and Docusaurus might be a 'Quick and Dirty' tool for a Pattern Library.

Maybe we should introduce another section for 'similar/related' tools?

@ran-dall
Copy link

However, there is certainly some overlap and Docusaurus might be a 'Quick and Dirty' tool for a Pattern Library.

@davidhund It's true, as it does allow you to build React components in your documentation; but not much else. If we're focusing on Pattern Generators; and not Style Guide Generators (cause there is some confusion there); then I'd argue this wouldn't be a Pattern Generator. I'd say the difference between the two is the lack of process in a Style Guide Generator (i.e., much less opinionated (e.g., Pattern Labs vs. Aigis).

Maybe we should introduce another section for 'similar/related' tools?

@davidhund I was getting to this on my last point, but I think it would be wise to point out the difference between a "Pattern Library Generator" and a "Style Guide Generator;" before we implement a "Similar/Related" area (that can be ambiguous and add some confusion). While similar and have overlap; they are not the same thing, IMO.

I would propose maybe adding a lightweight explanation (and resources) of the two methods and re-categorizing the list at the top level so that it's clear what tool follows which of the two. What would be your thoughts?

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