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.

Sign up for GitHub

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

Jump to bottom

Review schema vs collection documentation #2538

Closed
AndrewSisley opened this issue Apr 19, 2024 · 0 comments · Fixed by #2544
Closed

Review schema vs collection documentation #2538

AndrewSisley opened this issue Apr 19, 2024 · 0 comments · Fixed by #2544
Assignees
@AndrewSisley
Labels
area/collections Related to the collections system area/schema Related to the schema system documentation Improvements or additions to documentation
Milestone
DefraDB v0.11

Comments

@AndrewSisley
Copy link
Contributor

Public documentation, both in the Go codebase (i.e. client package), and the docs repo. Consider adding a .md file to the defra repo.

Particularly regarding global vs local fields.

#1386 and #1385 might be handy here too.
@AndrewSisley AndrewSisley added documentation Improvements or additions to documentation area/schema Related to the schema system area/collections Related to the collections system labels Apr 19, 2024
@AndrewSisley AndrewSisley added this to the DefraDB v0.11 milestone Apr 19, 2024
@AndrewSisley AndrewSisley self-assigned this Apr 19, 2024
@AndrewSisley AndrewSisley mentioned this issue Apr 22, 2024
Merged
AndrewSisley added a commit that referenced this issue Apr 22, 2024
@AndrewSisley
docs: Add data definition document (#2544)
9a250ff 
## Relevant issue(s)

Resolves #2538

## Description

Adds data definition document, documenting how data is defined.

It is targeted at us, and anyone looking to embed defradb in their
application.
ChrisBQu pushed a commit to ChrisBQu/defradb that referenced this issue Feb 21, 2025
@AndrewSisley
docs: Add data definition document (sourcenetwork#2544)
94b9c77 
## Relevant issue(s)

Resolves sourcenetwork#2538

## Description

Adds data definition document, documenting how data is defined.

It is targeted at us, and anyone looking to embed defradb in their
application.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AndrewSisley AndrewSisley

Labels
area/collections Related to the collections system area/schema Related to the schema system documentation Improvements or additions to documentation
Projects
None yet
Milestone
DefraDB v0.11
Development

Successfully merging a pull request may close this issue.

docs: Add data definition document AndrewSisley/defradb
1 participant
@AndrewSisley