rdoc icon indicating copy to clipboard operation
rdoc copied to clipboard

[DOC] New doc 'RDoc Documents'

Open BurdetteLamar opened this issue 5 months ago • 4 comments

BurdetteLamar avatar Sep 02 '25 01:09 BurdetteLamar

I think there is a lot of duplicate information in the "Writing Documentation" section in the README.md. I think we should consolidate this with that (or link to this from that).

I agree. I'd like to go ahead and merge this (redundancy is relatively harmless), and work on the README later on.

BurdetteLamar avatar Sep 02 '25 20:09 BurdetteLamar

@peterzhu2118, I also have in-work rdoc_sources.md, which the README can also link to.

BurdetteLamar avatar Sep 03 '25 17:09 BurdetteLamar

I think this is a good high level overview that should be put into the readme instead of a separate doc.

st0012 avatar Sep 07 '25 10:09 st0012

I think this is a good high level overview that should be put into the readme instead of a separate doc.

I wrote this to formally establish the term document, so that I can link to it whenever I write "top of the document" or "end-of-document."

I'd prefer its remaining a separate doc, and linking to it from the readme. I have some other things in-work, and had planned on re-working the readme in the near future.

BurdetteLamar avatar Sep 07 '25 19:09 BurdetteLamar