https://github.com/tpunt/php-internals-docs
Documentation for PHP's internals
https://github.com/tpunt/php-internals-docs
Last synced: 9 months ago
JSON representation
Documentation for PHP's internals
- Host: GitHub
- URL: https://github.com/tpunt/php-internals-docs
- Owner: tpunt
- Created: 2019-10-13T19:57:45.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-19T19:20:07.000Z (over 2 years ago)
- Last Synced: 2025-04-10T12:14:32.675Z (9 months ago)
- Language: PHP
- Homepage: http://phpinternals.net
- Size: 1.55 MB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Documentation for PHP's internals
tl;dr: To contribute, just submit PRs to this repo. Adding new categories and articles will use their url name for a file name. Symbols will use an arbitrary ID (pick any, but it must be unique). The way this is currently structured may change in future (open to suggestions and contributions on the docs server itself).
The original server application can be found at [tpunt/php-internals](https://github.com/tpunt/php-internals). I decided to discard those ~15k LOC of Elixir (backed by Neo4j, Redis, and ETS) because it was convoluted and I forgot how everything worked...
The new server application is built in PHP, where it simply pulls data from this repo, and passes it to the old client application (found at [liammann/php-internals-client](https://github.com/liammann/php-internals-client)).
To ensure that proper formatting is used, before committing your change, please run the [linter.php](https://github.com/tpunt/php-internals-docs/blob/master/linter.php) located in the base of this repo. This will tell you if, for example:
- A symbol or article has been deleted, but its ID is still present in a category
- A symbol has incorrect formatting (e.g.a variable containing parameters, or a function without a definition)