Re: php-src docs

Hi Yuya It seems you accidentally sent your response to me instead of the list. On Sun, Feb 11, 2024 at 5:10 PM youkidearitai <youkidearitai@gmail.com> wrote: > > 2024年2月11日(日) 21:18 Ilija Tovilo <tovilo.ilija@gmail.com>: > > > > Hi everyone. > > > > I would like to start an initiative to centralize documentation of the > > PHP internals. > > https://github.com/php/php-src/pull/13338 > > https://iluuu1994.github.io/php-src/ (will be moved to > > php.github.io > > once merged) > > > > Let me know of any thoughts and suggestions you might have. > > Hi, Ilija. > Thank you for your great suggestion. > > It seems make sense to have a set of documents about the structure of > php-src in php-src. > Easily create pull requests to them. > > Although I have to learn reStructuredText, It is not seems major problem. For some context, I initially planned to go with the mdBook from the Rust project (https://github.com/rust-lang/mdBook/) as Markdown is a bit more approachable. After writing the sample zval chapter, I noticed some pain points in terms of formatting, most significantly tables. That said, reStructuredText is far from perfect itself. As mentioned previously, the other reason for choosing Sphinx was that it is quite extensible. Ilija