yii2-apidoc
yii2-apidoc copied to clipboard
Guide's Mobile version improvement
This issue has originally been reported by @slinstj at https://github.com/yiisoft/yii2/issues/8773. Moved here by @cebe.
Principle: the guide's text should be the king:
Should have more space for the text;
Menu icon on the right up corner takes the entire line space, pushing the title down;
Should have a floating menu icon having the topics;
"Go to top" icon could be smaller and should not stand so over the text;
I don't think the "pencil" edit icon is useful since editions use to be made via PR. It's only one more thing to stands over the text;
At the end of the each topic it should be a next/before topic links;
Thanks for posting in our issue tracker. In order to properly assist you, we need additional information:
- When does the issue occur?
- What do you see?
- What was the expected result?
- Can you supply us with a stacktrace? (optional)
- Do you have exact code to reproduce it? Maybe a PHPUnit tests that fails? (optional)
Thanks!
This is an automated comment, triggered by adding the label status:need more info.
Not sure about this. Usually the docs are used simultaneously with writing code and majority of programmers use desktop / laptop setup with monitors or laptop screens as displays. It's hard to imagine someone's coding on a tablet / smartphone on a regular basis (except some extreme cases and experiments). Maybe you have a use case and can provide some details? @sdlins. This does not mean that we should not improve mobile version but it's not the high priority now I guess.
Another suggestion is to collect some stats using analytics services based on current user activity and rely on that for further decision.
@samdark What do you think?
Also images / prototypes would be more visual (If you have time of course) @sdlins.
@arogachev good approach. We previously had analytics on the website but removed it (I don't remember the reason). Need to re-add it.

Related - https://github.com/yiisoft-contrib/yiiframework.com/issues/699.