Merge documentation into a central resource on the Keep website

[creckhow-zz]

Including the documentation in a clear flow from the Keep website, and it's easy to get back to the main website. Added legitimacy that it's coming from the keep website domain and not from gitbook in the URL. (edited)

[creckhow-zz]

Even if the "resource center" isn't primarily the gitbook, we must have a flow or window to it on the Keep stakedrop page.

[creckhow-zz]

Tagging @liz-shinn @Gluzman here but this is also one for @mhluongo @Shadowfiend and @sthompson22 to weigh in on. (please assign yourself accordingly)

As we talked about in the stakedrop planning sessions, this is an age old discussion. Our ideal solution for documentation is to build a CMS on keep.network (like we've got for tbtc.network) but where real github issues push the content, so we can have streamlined place for all technical docs and community contribution.

Unfortunately we don't have the resources for that this month. Gitbook is the solution we came up with back in April, and it will continue to work well because:

• it's user friendly
• we can give it our branding & incorporate it into our main site
• we can invite community members to write changes for us to push

But we can agree it is not a long term solution.

For now gitbook is the SOURCE OF TRUTH for official staking documentation.

This card is asking for a strategic design decision on how gitbook is built into the stakedrop section of the new keep.network.

[creckhow-zz]

We need to learn more about how close we can get gitbook to our own website. It looks like we can't imbed it directly (and we might not want to -- it's OK for the docs to be separate).

We'd like the URL tied to our website. And have it easy to go back and forth to the current Keep site and gitbook

[liz-shinn]

[liz-shinn]

@Shadowfiend @ironng We'd like to assign the staking documentation GitBook a custom domain that's the same as the Keep website with a /docs on the end. What are your thoughts on this?

[Shadowfiend]

Potentially interesting, but we need a domain other than docs.keep.network since that already exists for tech docs. Could be staking.docs.keep.network or staking-docs.keep.network, but that’s a bit awkward.

[liz-shinn]

So if we've already got a paradigm for documentation at docs.keep.network is it possible to include more than the tech documentation at that domain?

For example, the random beacon documentation is at https://docs.keep.network/random-beacon/ could we have https://docs.keep.network/staking-documentation/ direct to the GitBook staking documentation?

[liz-shinn]

There's not currently anything there, it pulls up an XML error, so it could direct to the GitBook? It seems like that'd work; we're directing to a PDF for https://docs.keep.network/tbtc/index.pdf for example.

[Shadowfiend]

Basically, if all we’re looking for is a redirect that’s very doable. If we want the pages to look like they’re on our domain it’s less doable.

[liz-shinn]

I think for now a redirect is what I'm looking for. It adds the legitimacy / authenticity of it being under our domain vs. a gitbook domain, & also a lot of other documentation is under this docs domain (even though though they're not styled the same) so it'll train folks to look there.

[liz-shinn]

I understood "look like they’re on our domain it’s less doable" to mean styled like the docs random-beacon or run-random-beacon.

The URL would read docs.keep.network/staking-documentation right?

[Shadowfiend]

Sorry, no, that's what a redirect means here---we could link to docs.keep.network/staking-documentation, but the URL would ultimately read the current GitBook URL. Actually displaying GitBook's site under our own URL would require us to use the custom domain stuff, which means we'd need <something-else>.keep.network or <something-else>.docs.keep.network.

[liz-shinn]

Argh. Well, for now a redirect then. But ultimately (like we'd talked about in the design/tech sync call) a place where all this documentation is living under the same domain.

[liz-shinn]

Context: goal of the team based on our quarterly OKRs and continued requests from users in Discord to establish a central place to find documentation.

Below are a few references of implementations from other companies that prioritize the following:

• Community contribution
• Current / up to date documentation
• Central place to find docs

EXAMPLES

1. Ethereum Docs – If you click the edit icon in the corner from docs.ethhub pages, it will take you straight to the GitHub repo page to edit that section.
   https://docs.ethhub.io/ethereum-basics/what-is-ethereum/
2. GitHub Docs –
   https://github.blog/2020-07-02-how-we-launched-docs-github-com/