-
-
Notifications
You must be signed in to change notification settings - Fork 674
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
Restructure docs landing page and some docs ordering. #2463
Conversation
/cc @rmartin16 @HalfWhitt since you both expressed an interest in this topic. |
I think this is great 💯 and definitely an improvement on #2455. On the backend pages, it may be worthwhile to add As for the graphic, I definitely liked it on the landing page. I'm always a bit dumbfounded when I come to a GUI-centric library and there aren't any or at least any easily findable graphics. For perspective, this is what the landing page looks like for me: |
Ok - based on that feedback, I'll close #2455 and move forward on this one. I've restored the screenshot to the homepage. I've also merged the background section on platforms into the API - I noticed we had both; mostly duplicating the content; and in the reference section, the content is indexed by OS, rather than backend API. Lastly, I've filled in some missing detail on the roadmap. That started as me noticing the markup was off... and I got carried away :-) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mostly minor notes.
Co-authored-by: Russell Martin <russell@rjm.li>
A counterproposal to #2455.
Revises the documentation ordering so that:
A preview rendering is available
I'm not sure how I feel about the loss of the graphic - it was nice and splashy, even if it did take up a lot of space. I've removed it here for demonstration purposes, but I think I'd be just as happy to restore it.
PR Checklist: