Just the redirects, and nothing but the redirects

[wyhaines]

As we decommission this version of the docs, we want to leave behind a set of redirects from the old content to reasonably-equivalent locations in the new docs.

Description

This replaces the docusarus site with a very simple Jekyll site, which is GitHub Pages native format. It is composed of nothing but a set of redirects to the new developer docs portal. This should help to ensure that Google indexes for Topos related searches all end up at the new developer portal.

Breaking changes

This completely replaces the docusarus site with jekyll redirects.

PR Checklist:

• [ x ] I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have added or updated tests that comprehensively prove my change is effective or that my feature works

[dvdplm]

Why are some pages deleted and others redirects? Are the deleted pages the ones without direct correspondent on the new site? Maybe we could blanket-redirect such pages to the index of the new site?

[wyhaines]

Why are some pages deleted and others redirects? Are the deleted pages the ones without direct correspondent on the new site? Maybe we could blanket-redirect such pages to the index of the new site?

They are all redirects (unless I missed something, but I don't think that I did). Maybe what is confusing is the fact that docusarus has all of the pages under a docs/ directory, whereas the default for jekyll is that it starts right at the root directory (this default can be changed, but that was more tinkering than just letting Jekyll have it's defaults. Since GH Pages is built on Jekyll by default, I changed as little as possible.

Here are the markdown files under docs/ in the docusarus original, if I remove docs/ from the front of each filename:

build/overview.md
introduction.md
learn/tce/overview.md
learn/tce/conflicting-certificates.md
learn/tce/wcprb.md
learn/subnets/overview.md
learn/subnets/integration-flow.md
learn/subnets/cross-subnet-messages.md
learn/subnets/topos-subnet.md
learn/crypto-params/stark.md
learn/crypto-params/schnorr.md
learn/uci/overview.md
learn/uci/state-transitions-validity.md
learn/uci/authentication.md
learn/uci/certificate.md
learn/uci/certificate-lifecycle.md
learn/zkVM/overview.md
general-overview.md

Here are the redirects that I created.:

build/overview.md
build/index.md
learn/tce/overview.md
learn/tce/conflicting-certificates.md
learn/tce/index.md
learn/tce/wcprb.md
learn/subnets/overview.md
learn/subnets/integration-flow.md
learn/subnets/cross-subnet-messages.md
learn/subnets/index.md
learn/subnets/topos-subnet.md
learn/index.md
learn/crypto-params/stark.md
learn/crypto-params/index.md
learn/crypto-params/schnorr.md
learn/zkvm/overview.md
learn/zkvm/index.md
learn/uci/overview.md
learn/uci/index.md
learn/uci/state-transitions-validity.md
learn/uci/authentication.md
learn/uci/certificate.md
learn/uci/certificate-lifecycle.md
learn/zkVM/overview.md
learn/zkVM/index.md
general-overview.md
index.md

The difference is that I also added index.md files just to capture the edge case where a directory gets referenced, and a lowercase version of the zkVM/ directory because mixed-caps make me worry that people will do weird things. Those pages may never get hit, but it cost me very little to add the extra coverage, just in case. If you pull those out of the list, there is an exact match, file-for-file, except for introduction.md, which docusaurus is rendering as the index page of the top level domain.

So....I believe that I mapped all pages from the old docs to the new docs.

If I did miss something, let me know what you are seeing, please.

BTW, if you want to build this locally, it's fairly simple.

If you have any remotely modern Ruby on your system, just do:

gem install jekyll
bundle
jekyll serve -I

That'll start an incremental build and a web server, running on port 4000 (non-https) that you can interact with

[dvdplm]

Maybe what is confusing is the fact that docusarus has all of the pages under a docs/ directory, whereas the default for jekyll is that it starts right at the root

Aha, that explains it, I missed that. Ok, all good then.

[dvdplm]

LGTM modulo unused code.

[wyhaines]

To sanity check this, I forked the repo, applied this PR, merged, and let GH Pages build it. It works as expected.

https://wyhaines.github.io/docs-test/