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
[docs] Add API menu and demo button #6455
Conversation
oliviertassinari
commented
Mar 28, 2017
- PR has tests / docs demo, and is linted.
- Commit and PR titles begin with [ComponentName], and are in imperative form: "[Component] Fix leaky abstraction".
- Description explains the issue / use-case resolved, and auto-closes the related issue(s) (http://tr.im/vFqem).
Clean-up is pretty sweet. Doubt I could ever have got it looking that good, never mind so quickly, but:
Can't see it there, but as well as the odd highlighting, links are underlined. (
|
We need to change the tree structure to make it work. It needs to carry more information. Still, answering 80% of the issue. That was simpler to begin with.
That was simpler to implement without that feature. I don't think that it's the core of the issue, hence put it aside.
Yep, that's an issue at the menu level, I think that we should able to use simple link over imperative API to navigate. Thanks for the review. |
I had already changed the tree structure, and this was already working. (Ignoring that I had barely got started on the rewrite when I stopped to get feedback on the new tree structure).
I can take care of it.
It most definitely is.
Since you can't view them together, we need to make getting from one to the other much easier. |
Sorry, I'm not referring to the file tree structure, but the data structure.
I agree, there is a need for it, I was think of having a AutoComplete search field to solve more complexe use cases like this one. Do you think that we can merge that PR and continue the iteration? |
The flattened directory structure simplified populating the data structure. Like I said, this was already working (just far from its final form).
To use AutoComplete to find related components, you need to know what you're searching for. In most cases related components have the same base name, but not always. I'd see search / AutoComplete across the entire API as complementary to something that explicitly lists the related components.
Sure. I'm probably going to tweak some of the file and function name changes, but that can be part of a separate PR that completes / reinstates the missing parts. This is a step forward as is. |
I agree with your points 🎉 , let's get a nice UX for the docs 😄 . |