wplib / box-docs

Documentation for WPLib Box

WPLib

A PHP Library plus Conventions for Building Complex Custom WordPress Apps

WPLib was designed for use by teams who build custom sites and need professional workflow. The library is a thin layer that provides a simple Module System and a lightweight Model+View architecture.

WPLib is for those professionals who want their custom-developed WordPress sites to be both robust and easy to manage and maintain as site complexity grows.

Documentation

You will find documentation in its current state on the wiki.

box-docs's Issues

Step 6 - Incorrect example provided

https://wplib.github.io/box-docs/quick-start/index.html

Issue with the following step:
6. Open project.json in your text editor and change the line

Suggests the following will be provided:

"hostname": "box.local"

but the project.json from the wplib has the following:

"hostname": "wplib.box",

In my fork of the box documents I have updated step 6, is it worth submitting PR, or is it better to change the project.json to match the docs?

WPLib Box Quick Start Instructions - Open links in new tabs

https://wplib.github.io/box-docs/quick-start/index.html

https://github.com/wplib/box-docs/blob/master/docs/quick-start/index.html

On the quick link instructions it might be better to open the links to Virtual Box and Vagrant in new tabs.

Could just be personal, but I find opening and closing new tabs easier for navigation than browsing back. I like to keep the originating page open so I can continue to read through the documentation and have all the links open in new tabs.

<mark><a href="https://www.virtualbox.org/wiki/Downloads" target="_blank" rel="noopener noreferrer"><strong>Virtual Box</strong></a></mark>

<mark><a href="https://www.vagrantup.com/downloads.html" target="_blank" rel="noopener noreferrer"><strong>Vagrant</strong></a></mark>

I have forked the box-docs, will make adjustments and submit a PR if you think this is worth updating?