specs
specs copied to clipboard
Removing org-mode files
@olizilla mentions that the 3 org-mode files we have in the repo are a problem. Hence I looked into it and I'm in favour of removing them and not spending time on getting them working again.
I've looked into those files. They are (probably) in org-mode as they have a relation to Orient. Orient was removed from this branch of the repo, so we cannot have this relation anymore.
In addition to that, the currently published spec also doesn't render it correctly. I also think that the contents of the files in org-mode are heavily outdated:
- https://github.com/filecoin-project/specs/blob/37e290db94259c5d9b17a7918cbc351f92c6d98b/content/appendix/orient.org: That one doesn't even show up in the currently published spec (at least i cannot find any occurence of "BLOCKS-IN-TEN-YEARS".
- https://github.com/filecoin-project/specs/blob/beta/content/algorithms/post/proof_of_spacetime_parameters.org: This table can easily ported to Markdown. Is it still accurate? Is this the right place to have it? I suggest also removing this org mode file and bring the information back at a place where it makes sense
- https://github.com/filecoin-project/specs/blob/beta/content/algorithms/porep/porep_commitments/sdr_commitments/_index.org: that one renders better on GitHub then in the currently published spec. Though again a lot of orient stuff in there. It also talks about ZigZag which I think (though I'm totally unsure) is not used in the proofs anymore.
If the Orient things have been completely removed from the spec, then you should be very safe removing anything org mode. It's also by definition going to be very old and out of date, which is another reason you can remove it.