common-lisp-libraries icon indicating copy to clipboard operation
common-lisp-libraries copied to clipboard

Push documentation upstream

Open phoe opened this issue 5 years ago • 2 comments

Some parent projects, such as Bordeaux Threads, could use documentation updates in their main repositories when it is complete.

phoe avatar May 18 '20 13:05 phoe

For the most part, the documentation is taken from the docstrings. (alexandria and postmodern are an exception atm.) However, there does go much manual efforts in hyperlinking or formatting, due to either inconsistent formatting, or wanting to avoid hyperlink-cognitive-overload for the reader.

And let me clarify the title of this issue: you want the official documentation to be used here - is that the case?

digikar99 avatar May 18 '20 13:05 digikar99

Nope, I want the inverse - the official documentation is often out of date and could use efforts that update it, with BT being one example that I am aware of.

phoe avatar May 18 '20 14:05 phoe