Skip to content

Conversation

@GitMensch
Copy link
Collaborator

  • reformatting for markdown (the old version was broken concerning the bits)
  • reordered to have common notes before going into details

There are a bunch of other changes the manual may need an update to be nicely shown as markdown (starting with C code blocks, going on with more structuring, ... but that will take some time (and is a task I may be up to if we can agree on those changes up-front).

* reformatting for markdown
* reordered to have common notes before going into details
@GitMensch GitMensch requested a review from Bill-Gray June 18, 2025 06:17
@GitMensch
Copy link
Collaborator Author

... Just thinking about changes I may applyI see that this reformatting and adjustment seems like a task an insstructed LLM could handle well, so my task would be "only" the instructions and checking the diff... that would at least be faster.
Is that something that woulds be considered fine (PDC is public domain, but before I use LLM for such a global change to the doc, I still like to ask, after all I can do that myself as well [and no one should do task with an LLM he cannot do, but that's a side rant]).

@Bill-Gray
Copy link
Owner

Seems like a good idea. A couple of small hitches, though.

MANUAL.md is built automatically, by searching for text in the source files, using docs/mkman.sh. That hasn't been done for about a year, and the existing MANUAL.md lacked some updates concerning the panel library and three newer multi-byte to wide-character (and vice versa) functions. I just added commit 6f719c7 to bring it up to date. (Fortunately, that doesn't conflict with what you've done.)

However, the changes/reorganization in comments about attribute bits should be done in curses.h, and docs/mkman.sh then run so that the changes get reflected in MANUAL.md.

I noticed a while back that @wmcbrine has done some work to make the manual more markdown-friendly (table display, for example). We may want to cherry-pick commits such as wmcbrine/PDCurses@aa8d315f, wmcbrine/PDCurses@574895223, wmcbrine/PDCurses@26f39dec9, wmcbrine/PDCurses@2d5ddb75b, and some of their predecessors... he did quite a bit there.

I'm deeply skeptical of so-called "AI". But this is a case where I'd think you could give it a try, and the changes would be such that we could look at it and either say "oh, heck no", or grudgingly admit that it was actually okay. I don't think copyright would be an issue.

@Bill-Gray
Copy link
Owner

Should note it's not so much a matter of "the old version was broken concerning the bits"; it's more a matter of "the old version is from a pre-Markdown universe".

@GitMensch
Copy link
Collaborator Author

Cherry pick doc work sounds good - can you give that a try?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants