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

Issue-101, Design Documentation #116

Closed
wants to merge 3 commits into from
Closed

Issue-101, Design Documentation #116

wants to merge 3 commits into from

Conversation

worryg0d
Copy link
Collaborator

@worryg0d worryg0d commented Sep 3, 2024

This PR provides a little design documentation for the crates the project includes. It covers such crates as:

  • wavbrro
  • vsri
  • brro-compressor
  • csv-compressor

Related to #101

@worryg0d worryg0d added documentation Improvements or additions to documentation opensource-release Issues related to the opensource release of the repo labels Sep 3, 2024
@worryg0d worryg0d self-assigned this Sep 3, 2024
docs/design.md Outdated
BRRO
--

For more details on BRRO, including what it is and the concept behind it, you can refer to this [paper](../paper/BRRO.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

I think that we can also add information about the full flow of the compression-decompression and possible use cases

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I added some information on its concept, reading/writing flows for time-series data storing.

@testisnullus testisnullus self-requested a review October 8, 2024 10:32
@cjrolo
Copy link
Collaborator

cjrolo commented Nov 28, 2024

Closing as this was done in several other steps.

@cjrolo cjrolo closed this Nov 28, 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 opensource-release Issues related to the opensource release of the repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Publish design and architecture documentation to guide users and contributors
3 participants