Document and extend index serialization format
Open
enhancement
- Dominant language
- Rust
- Stars
- 1.9k
- Forks
- 454
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 35
Description
Is your feature request related to a problem? Please describe.
The current format for saving indices -- inmem and disk -- needs to be documented. It also does not allow for storing start point strategies.
Describe the solution you'd like
For both in-mem and SSD indices, extension of current format and documentation.
Steps
- Agree on requirements, target scenarios, exit criteria.
- Agree on proposed solution.
- Save index. Access artifacts.
- Backward compatibility
Contributor guide
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.
Assessment
This issue has not been assessed yet.