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

Technical documentation for documents store #1691

Open
tomekkolo opened this issue Jun 6, 2023 · 4 comments
Open

Technical documentation for documents store #1691

tomekkolo opened this issue Jun 6, 2023 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@tomekkolo
Copy link
Contributor

Document json object storage implementation, including in code comments and also general technical description (including diagrams etc. )

@tomekkolo tomekkolo changed the title Technical Documentation for Object Model Technical documentation for documents store Jun 6, 2023
@tomekkolo
Copy link
Contributor Author

@arriqaaq , maybe interested to contribute ? :)

@tomekkolo tomekkolo added the enhancement New feature or request label Jun 6, 2023
@arriqaaq
Copy link
Contributor

arriqaaq commented Jun 7, 2023

@tomekkolo ack, can you let me know broadly what all would be required in the in code docs? Just to get an idea because diagrams for the document store, not sure exactly what to draw there for in code documentation. I guess they way we encode the keys, but not sure if that would be really helpful for the end user

@tomekkolo
Copy link
Contributor Author

it is not documentation for end user, but for developers. So more like if someone would like to contribute. Basic architecture diagram and description, how sql is used and what are the difference, how we map keys etc.

@arriqaaq
Copy link
Contributor

I am working on this, just wanted to keep you updated :)

Please assign this to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants