V4 Documentation

[ragboyjr]

• [ ] Template Shared Data #136
• [ ] Extensions
• [ ] Internal Architecture
• [ ] Trouble Shooting
  • Just create documentation on any of the exceptions and what they mean and how to resolve to help people who get an exception they didn't expect.
• [ ] Advanced Usage
  • Aliasing Funcs
  • Utilizing the __invoke func
  • Overwriting/extending existing funcs
  • Developing your own func
  • Using Props

[ragboyjr]

For the docs, i need to build a tool that will take a few branches, build the jekyll site in the doc folder and put each built site in folders inside of gh-pages. It should work similar to Couscous where it builds the generated site, the moves it to a temp folder, checks out the gh-pages branch, and then merges/commits the branch.

[lkraav]

@ragboyjr what would it take to get the v4 docs going somewhat? Would be useful to understand if v3 docs are enough to get started, or any major confusing differences?

[lkraav]

Pardon my ignorance. I overlooked that a nice set of v4 docs are already up on the site definitely seem to be enough to get started. Or maybe it was some usability issue that made it hard to recognize differences after the version dropdown selection in the sidebar.

http://platesphp.com/v4-alpha/engine/framework-integration/ are there any major changes coming here vs v3?

[ragboyjr]

@lkraav no worries, I think the main interface won't change much, but I do think I want to re-work some of the internals to be a bit simpler.

[lkraav]

no worries, I think the main interface won't change much, but I do think I want to re-work some of the internals to be a bit simpler.

@ragboyjr what's your workflow? Could we attack this in pair programming mode? Sometimes it takes a more active "together" to get things moving.

[ragboyjr]

@lkraav not opposed, but i'm slammed with work prepping for holidays, so we might need to discuss when i'm not so swamped.

[lkraav]

Lovely, got my first Plates integration working https://github.com/lkraav/mythic/commits/plates-view

One of the v4 docs related question I discovered: since I'm using my framework's hierarchy builder, Plates is getting a pre-built full filesystem template file path to each render call, sort of obsoleting its own template base engine parameter.

Seems to work, but just wondering if this may or may not have any side effects, or it's totally fine.

[lkraav]

I'm not sure how and if it's a good idea to use default_layout_path parameter at all.

[ragboyjr]

default_layout_path is my jam. Most of my templates use the same layout file. so instead of adding $this->layout('layouts/main') in all of my templates, I can set 'default_layout_path' => 'layouts/main' and remove the layout directive in the template.

[butteredptarmigan]

I think it would be a good idea to follow the widespread trend found on readthedocs and create one page with detailed API documentation, i.e. to document every method automatically, using a tool like phpDocumentor. It would be a great help for nerds and as a quick reference.