Skip to content

Conversation

BurdetteLamar
Copy link
Member

No description provided.

Copy link
Member

@peterzhu2118 peterzhu2118 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

@BurdetteLamar
Copy link
Member Author

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
Copy link
Member Author

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

@st0012
Copy link
Member

st0012 commented Sep 7, 2025

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

@BurdetteLamar
Copy link
Member Author

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.

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

Successfully merging this pull request may close these issues.

3 participants