[GitHub] [logging-log4cxx] rm5248 commented on pull request #238: Improve the structure, clarity and correctness of documentation

["rm5248 (via GitHub)" <gi...@apache.org>]

rm5248 commented on PR #238:
URL: https://github.com/apache/logging-log4cxx/pull/238#issuecomment-1648841643

   Minor notes:
   
   - The 'layouts' section that is currently in the 'Loggers, appenders and layouts' section may want to be instead in the 'Configuration samples' page.  Or we should link to that from the 'Configuration Samples' page since it talks about updating the pattern layout for one of the XML files.
   - On the filters page, it may make sense to add in the anchors (`{#labeling-log-output}`) so the TOC won't have doxygen auto-generated links.  Also apparently 'labeling' can have one L or two, I did not realize that.
   - The 'examples program' page is currently called 'coding'. Maybe that should be renamed to something like 'quick-start' and be the first page under 'usage'?
   
   Another thing TODO(may be good for separate PR): on the 'releases' page, we should have a link to the documentation for that particular release(help prevent link rot, so you can get documentation for a particular release).  e.g. 1.0.0 doc is here: https://logging.apache.org/log4cxx/1.0.0/


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org