reshufflehq / dev-docs Goto Github PK

I didn't want to include fontawesome in the bundle so I opted to use the cdn they generate for you on the main site. This cdn apparently has terrible performance resulting in icons "popping in" after a few seconds.

this.props.history.location can be undefined

Originally posted by @zolga in https://github.com/binaris/dev-docs/pull/29/files

Side menu should indicate with proper icon/symbol when the sub menu is collapse and expand

The public roadmap https://trello.com/b/e4Hfp3cB/public-roadmap should be in our sidebar, probably in "Other Goodies".

Public roadmap shouldn't be it's own item on the sidebar, but rather reside within one of the existing categories.

1. The scrollbar is on the wrong element, resulting in functional but awkward look
2. The scrollbar is not hidden (specifically for mobile)
3. No smooth scrolling

Right now the mechanism used to specify the default page leaves a lot of room for bad UX and race conditions. Instead, we should use a separate key in the DB for the default page, thereby removing complexity and potentially bad UX.

Suggested here: https://github.com/binaris/dev-docs/pull/5/files

Great suggestion by @vogre in #23.

We should ensure that every snippet has a convenient way to be copied!

On mobile/smaller devices, the icons overflow

VALID_HOSTED_DOMAINS needs to be as of right now or won't load and no errors

src/Containers/SidebarContent.jsx
function SidebarContent

const lowerCat = page.category.toLowerCase();
if (page.category === undefined) {  

First line will throw an error if page.category is undefined.

Right now, much of the code is written assuming a single admin user will be modifying/managing content at a time. We should determine what experience we want to provide, and then scope the work required to comprehensively support this experience.

The page should scroll to its previous position when the user hits "back" or other browser navigation

When the view width is sufficiently small (even 600px) the code snippets begin to overflow the viewport. As of now, a horizontal scrollbar is expected to be used to view the full code on smaller screens. This is definitely suboptimal, and if you look at a site like reactjs.org, you'll see that they handle this eloquently.

We should follow in their footsteps and make code readable at any width, without horizontal scrollbar.

Right now the site will scroll even if the route doesn't include an anchor (like #subheader). This should be fixed.

The dev-docs site should have its style aligned with the main webapp

Right now it's impossible to get back to reshuffle.com from the dev-site. This should be changed

Because we do a direct check on paths, the homeRoute / won't match the actual route of the page. We need to add an additional check about the route.

There should be standardized font-size's and colors throughout the site. Margins of markdown/page content should be in relative font units.

Right now the authentication expects that any users have provided a valid hosted domain and have a org email with Google. This is impractical and should be changed to allow for single email whitelisting/blacklisting.

Roboto is a non-monospace and generally does not look good with code. Using something made specifically for code such as source-code-pro is probably a much better idea.

Users complained that there was no easy way to access the API Reference site from the dev-docs site. I've added a hardcoded category/link into the sidebar to solve the immediate problem. We should find a long term solution that aligns with the site style/flow.

Currently code samples adhere to vanilla wrapping/scaling. This results in a pretty poor visual experience on smaller screens.

Right now the arrows that show which category is currently selected have some pitfalls.

• They don't update when category is manually closed
• They don't work when the back button is used