search

wptide / docs

Tide is an automated tool to provide insight into WordPress code and highlight areas to improve the quality of plugins and themes.
https://wptide.org/
MIT License
24 stars 14 forks source link

WIP: Update docs structure and content #8

Closed luboskmetko closed 6 years ago

luboskmetko commented 6 years ago

This updates docs structure and content.

luboskmetko commented 6 years ago

@jeffpaul @MakiBM to make things simpler I've decided to continue with docs updates under this PR.

Just updated content on the home page and have one suggestion regarding that - I'd consider moving Search Plugins & Themes functionality to a separate page so it appears in the sidebar navigation, for example like Showcase here - http://docpress.github.io/. IMHO it would be more logical flow - user gets familiar with Tide on the home page and then can try it out in the next step. Also if the functionality outputs a lot of content (audit report), it would be easier to scan on a separate page.

MakiBM commented 6 years ago

@luboskmetko I leave it up to you. You may feel free to move the snippets to a separate file

jeffpaul commented 6 years ago

Content + structure looks fine so far, let's continue adding in documentation and we can look to merge this PR at the end of the week and next week handle small tweaks as needed.