Menu
▾
▴
Re: [Sbcl-devel] SB-MANUAL contrib prototype
|
From: Gábor M. <me...@re...> - 2026-06-07 22:36:34
|
Alright. The latest code and documentation are at https://github.com/melisgl/sbcl/commits/pax-doc/. The interesting commit is "PAXlike docs". The rest are bug fixes, and three large commits with docstring updates, lisp files with manual sections, and generated texinfo files. The following files were generated using the new Markdown-to-Texinfo converter, and subsequently compiled with Texinfo. https://quotenil.com/blog-files/sbcl-pax-doc/texinfo/sbcl.html https://quotenil.com/blog-files/sbcl-pax-doc/texinfo/sbcl.info https://quotenil.com/blog-files/sbcl-pax-doc/texinfo/sbcl.info-1 https://quotenil.com/blog-files/sbcl-pax-doc/texinfo/sbcl.info-2 https://quotenil.com/blog-files/sbcl-pax-doc/texinfo/sbcl.info-3 https://quotenil.com/blog-files/sbcl-pax-doc/texinfo/sbcl.pdf The above are quite close to the current documentation (e.g. https://www.sbcl.org/manual/), but lots of small fixes have been made to the docstrings as well. The following alternatives were generated with PAX, with the command line ./contrib/sb-manual/make-pax-docs.sh https://github.com/melisgl/sbcl https://quotenil.com/blog-files/sbcl-pax-doc/sbcl-manual.txt https://quotenil.com/blog-files/sbcl-pax-doc/sbcl-manual.md https://quotenil.com/blog-files/sbcl-pax-doc/sbcl-manual.pdf https://quotenil.com/blog-files/sbcl-pax-doc/html/sbcl-manual.html The main feature in these files (well, except the txt one) is linking: - cross-linking within the document, - linking to the CLHS, and - linking the locative (e.g. "[function]") to the sources on GitHub. SBCL, PAX, DRef, 3BMD and Slime required a couple of fixes. They are all available on GitHub (except https://github.com/3b/3bmd/pull/74), and hopefully in Ultralisp by now. For more information, see - the SB-MANUAL documentation https://quotenil.com/blog-files/sbcl-pax-doc/html/sbcl-manual.html#x-28SB-MANUAL-3A-40SB-MANUAL-20MGL-PAX-3ASECTION-29 - the docstring style guide: https://github.com/melisgl/sbcl/blob/pax-doc/contrib/sb-manual/README.md - and the TODO list: https://github.com/melisgl/sbcl/blob/pax-doc/contrib/sb-manual/TODO.md To avoid merge conflicts, I'll probably commit this soon if there are no objections, and then take my time with the TODO list. Cheers, Gábor |
