clockworklabs / clockworklabs/SpacetimeDB
Docs - Internals: add BFLATN.md
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 25.2k
- Forks
- 1.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 46
Description
To document our in-memory and on-disk format, in case someone wants to inspect pages in snapshots for some reason.
Is there a priority below P3?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the implementation of the BFLATN in-memory and on-disk format and any existing internals documentation. Document how the format is represented and stored in a new BFLATN.md, with enough detail for someone to inspect pages in snapshots.
Written by the indexing model from the issue text.
Assessment
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100