Update documentation

[elshize]

Updating documentation to reflect current master version.

[codecov]

Codecov Report

Merging #438 into master will increase coverage by 0.76%.
The diff coverage is 96.49%.

@@            Coverage Diff             @@
##           master     #438      +/-   ##
==========================================
+ Coverage   92.46%   93.23%   +0.76%     
==========================================
  Files          91       92       +1     
  Lines        4939     4998      +59     
==========================================
+ Hits         4567     4660      +93     
+ Misses        372      338      -34     

Impacted Files	Coverage Δ
include/pisa/sharding.hpp	92.05% <0.00%> (-1.24%)	⬇️
include/pisa/io.hpp	96.15% <100.00%> (+0.50%)	⬆️
include/pisa/taily_stats.hpp	100.00% <100.00%> (ø)
include/pisa/bit_vector.hpp	97.95% <0.00%> (+0.40%)	⬆️
include/pisa/wand_data_raw.hpp	100.00% <0.00%> (+12.76%)	⬆️
include/pisa/wand_data.hpp	85.55% <0.00%> (+23.05%)	⬆️
include/pisa/scorer/scorer.hpp	73.33% <0.00%> (+26.66%)	⬆️
include/pisa/scorer/quantized.hpp	100.00% <0.00%> (+100.00%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b64ab0d...f2293b9. Read the comment docs.

[elshize]

The diagram can be found here (as it won't appear in source or on github preview): https://github.com/pisa-engine/pisa/blob/docs-update/docs/source/_static/img/pipeline.png

I'm not sure if I'm making those inter-links properly, but I think so.

[JMMackenzie]

Assuming the links work, this looks great. Nice diagram btw :-)

[elshize]

@amallia can we verify the links before merging? E.g., can I build it locally?

[amallia]

I think we shoudl rename WAND data in the diagram to reflect the naming we used in the OSIRRC paper (which was Index Metadata).

[amallia]

LGTM. just a small comment

[elshize]

I added an issue for changing the name of wand data: #442 at this point let's leave it what it is in the diagram and docs, I don't want to create confusion. We should change the name everywhere at once.