Add API reference and guides under doc/ - #603
Open
laruence wants to merge 3 commits into
Open
Conversation
Signatures are generated via Reflection from the loaded extension, so they always match what the code registers -- no hand-transcribed typos like the ones in the old manual (isOption/geModules). Descriptions and examples are cross-checked against the 3.3.8-dev sources, including recent behavior changes (forward_limit=0 now clamps to the default, Dispatcher::getInstance requires an initialized Application, Session no longer keeps a stale $_SESSION pointer). - classes/: 38 class/interface pages, 233 own methods documented - guides/: quick-start, lifecycle (plugin hook timeline), directory-conventions (loader naming rules), routing, error-handling - llms.txt / llms-full.txt: AI-friendly entry points
The llms.txt convention is a site/repo-root convention, so the AI entry points are easier to discover at the top level. Internal links are rewritten with the doc/ prefix accordingly; doc/README.md updated.
laruence
force-pushed
the
doc/api-manual
branch
from
August 16, 2026 05:09
8257fea to
904b708
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Yaf has been carrying an old Chinese manual (
doc.laruence.com-era HTML) with known transcription errors (e.g.isOptionvsisOptions,geModules) and no documentation for 3.3.x behavior changes. This adds a fresh manual underdoc/built on two guarantees:yaf.forward_limit=0now clamps to the default (previously an infinite loop),Dispatcher::getInstance()requires an initialized Application, Session resolves$_SESSIONfrom the symbol table on every access.Contents
classes/guides/quick-start.mdguides/lifecycle.mdYAF_PLUGIN_HANDLEcall sites)guides/directory-conventions.mdyaf_loader.c)guides/routing.mdguides/error-handling.mdconstants.md/ini.mdYAF_ERR_*constants and ini directives with defaultsllms.txt/llms-full.txtDescriptions are in Chinese; signatures and examples are language-neutral. Prose lives in
doc/annotations/separated from signatures, so the two can evolve independently.Test plan
doc/guides/lifecycle.mdanddoc/guides/directory-conventions.md(the two most source-sensitive pages)