Origen-SDK / o2

MIT License
4 stars 0 forks source link

Doc-Documentation Lapses & Inadequecies #122

Open coreyeng opened 3 years ago

coreyeng commented 3 years ago

Hello,

@ginty has done some great work on making the Origen pages more aesthetically pleasing. This is also shows though that the doc generator seems to be working now (after some bumps that'll be merged soon).

I did provide a lot of content originally but there are still some lapses and confusing bits floating around that I didn't catch. I opened this ticket specifically to enumerate where these lapses are. I plan to leave let this stew for a bit as the documentation generator hopefully gets some usage and I'll update intermittently as I have time. I think this is will work for a first-round pass on the docs instead of opening multiple issues.

I have a few items pointed out already:

Feel free to pile on additional things as they come up.

Thanks!