Docs: missing pieces
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Quiet
- Tech stack
- php
- Domain
- documentation
Research direction
Start by reviewing the proposed minimal example in page/index.html and page/index.php, then inspect the existing documentation structure before organizing the listed topics. The issue spans getting started, installation, user guide, tutorials, and further reading, so done means the requested sections and explanations are documented with appropriate links and examples.
Written by the indexing model from the issue text.
Description
Overview:
Explain the following:
- the difference between Page View, Page Logic, API View/Logic, components, partials.
- HTML is concatenated/assembled before DOM processing.
- How the DOM document is manipulated with
data-bind. - PHP is optional and added only when needed by the developer.
- Dynamic route filenames can be used with
@. - Magic files like
_header,_footer, and_common, and when not to use with partials. - Logic methods
go,do_*with links to read more about advanced usage (go_after, for example). - Where client-side build tooling fits.
- Dependency injection and logic files (lazy loading).
- Database access.
- Object oriented alternatives to GLOBAL usage.
A minimal example project can be shown with page/index.html and how to manipulate the page in page/index.php.
Next page: Getting started to get set up for development quickly.
Getting started:
- I want to build my first webpage.
- I want to make my page dynamic.
- I want to build an API.
- I want to update part of a page.
- I want reusable page parts.
Next page: information about installation on different platforms, or using gt commands
Installation:
gt commands:
Blueprints:
After this, Tutorials section.
User guide:
- Request-response lifecycle
- Running your application (gt run = serve + build + cron)
- Project layout
- Application architecture
- Web servers (inbuilt, nginx, lighttpd, apache)
- URIs
- Page View
- Dynamic URIs
- Headers and footers
- Partial template pages
- Page Logic
- Protected globals
- User input
- Cookies
- Sessions
- Dynamic pages with the DOM
- Custom HTML components
- Database
- Client side assets
- API development
- Security
- Configuration
- Client side build system
- Coding styleguide
Further reading:
- Distinct Logic Authority
- SPA, MPA and Hypermedia (SPAs break hypermedia, MPAs often have less UX, multi-pass rendering)
- Fluid User Experience with Flux
- Speed & benchmarks
- Caching
- Service workers
- Repository-Entity pattern
- Dominant language
- PHP
- Stars
- 26
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from phpgt/WebEngine
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 50/100
-
question
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Similar issues
-
Solved site promotion gate fails on runner PHP patch drift (expects 8.2.33, runner installs 8.2.34) Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Automattic/blocks-engine#2161 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Automattic/static-site-importer#1824 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
0. Needs triage bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
0. Needs triage 35-feedback bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100