Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of ouraTypes could use some help #769

Open
emiflake opened this issue Apr 11, 2024 · 0 comments
Open

Documentation of ouraTypes could use some help #769

emiflake opened this issue Apr 11, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@emiflake
Copy link

From what I have found, the clearest documentation for the types oura emits through the various pub-sub streams is in ouraTypes.ts. And this serves quite well for reading through the core types. But there are two notable issues:

  • It's hard to find this file anywhere, I happened across it while browsing this repo.
  • GenericJson isn't generic at all. It follows a specific format that is unspecified anywhere but clearly has its roots in the pallas source code with specific decisions made. A user of oura will have to manually reverse how it's implemented and follow the breadcrumbs back to the rust source code. Of course, it differs between plutus_data and script_json, but they both follow specific formats.

I propose we give a little bit more attention to this file, or create a proper document for it, either works. Then, I propose we drop GenericJson in favour of more specific types that actually follow the implementation in oura, and ultimately in pallas. I suppose for the latter bit, if pallas itself had documentation for these types, we could instead link there, but I have not found anything there either.

@scarmuega scarmuega self-assigned this Oct 10, 2024
@scarmuega scarmuega added the documentation Improvements or additions to documentation label Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

2 participants