flyntwp / flynt-docs Goto Github PK

It's wrong in the main readme and in a few more places through the docs.

This is going to be a fun find and replace to do!

This should cover:

• Global Options
• Translatable Options
• Using the ACF sub-feature OptionsPages (and how to use OptionsPages::get).

Add a better set of favicons with http://realfavicongenerator.net/

• Open the navigation and scroll down - the menu is not correctly stuck to the top of the page.
• Open the navigation on mobile and resize to desktop - the open mobile menu is still visible.

These are old and need to be re-tested / updated.

We should use consistent brand colours and they should feel like they belong together.

We should be consistent, and it redirects to the link with the trailing slash anyway.

• Does Flynt work on node v7? The current requirements state Node >= 6.0.

Probably not needed anymore since setting the correct production base url is handled by Jenkins.

• Check if this task is really necessary and remove it if not.

so that it could be over-written on the page

I would like to encourage people to contribute to the documentation. This is something I liked about the Gitbook build that we are now missing.

It's in "core" which doesn't really make sense. Tasks like moving to sass from stylus is not related to the core plugin. We also had some early feedback from reddit users who could not find this section easily.

Since we use this now.

Need to decide where this should go.

I noticed that the code examples aren't horizontally scrollable on mobile (iOS) at all in some places (like here core/customization.md) or they could be improved with -webkit-overflow-scrolling: touch (like here (components/view-templates.md).

Works on local but broken on live. Is this related to #45? @domtra can you please take a look into this?

I feel I'm a little stuck on this page. As this might be one of my very first entry points to getting my hands on Flynt, it could be beneficial to link to some next steps at the end of the page. Maybe even to the "Develop a Simple Flynt Component in 6 Steps" Tutorial?

There's a lot of messy styling that we inherited from the theme we started with that we can clean up so that the docs is a lot easier to maintain on the front-end.

Some links target the README.md, some target the feature folder.
I would suggest to consistently link to feature folder as it will display the README.md anyhow.

• Removed DataFilters for good
• Removed initComponentData
• Renamed modifyComponentData to addComponentData

PR: flyntwp/flynt-core#32

This may be fixed in the theme in the future, but for now we should explicitly state that when you reference an image in CSS from a component, it needs to be from two levels up. (../../Components/)

http://localhost:1313/guide/components/static-assets/#using-static-assets-in-styles

Check if this is the best solution: https://github.com/GitbookIO/rousseau

https://docs.flyntwp.com/guide/features/using-features/

There's not enough there atm. @Qakulukiam what's a current feature that has some good examples of what's missing / what's possible?

To me, the burger icon is very small and thus hard to click. Additionally, navigating the menu – once opened – feels hard, because I first have to toggle the Guide, then chose a subtopic and then the detail page. And if there are too many items open, I can't scroll down the menu.

The mobile menu might not be the most important feature to the docs anyhow, because I assume you rather go there by a referring link or search (btw: why is the docs search missing on mobile?), but we should at least consider guiding the user better from page to page.