search

consensus-shipyard / ipc

🌳 Spawn multi-level trees of customized, scalable, EVM-compatible networks with IPC. L2++ powered by FVM, Wasm, libp2p, IPFS/IPLD, and CometBFT.
https://ipc.space
Apache License 2.0
41 stars 35 forks source link

docs: move docs into monorepo #1014

Closed maciejwitowski closed 1 month ago

maciejwitowski commented 4 months ago

At the moment, IPC docs are in the separate repo https://github.com/consensus-shipyard/docs We want to simplify them by adding to this repo. Since in this repo docs folder already exists, they were put in docs-gitbook. The structure and naming of docs can be easily updated later.

Next, the migrated docs are used to render the gitbook page. I created this separate gitbook space for the purpose of checking. It will replace the main one once this PR is merged.

maciejwitowski commented 4 months ago

@raulk Not bloating the repo makes sense. IIUC git clone will still be bloated if I just add a commit which removes assets folder from this repo and changes the links, correct? Does it mean I should copy folders/files without migrating the whole history?

raulk commented 4 months ago

@maciejwitowski it won't because we'll be squashing this PR in. You can migrate the assets by adding a commit to this PR.

maciejwitowski commented 4 months ago

@raulk Please check again. The docs website is already running from this branch https://docs.ipc.space/ Had to clean all these files in the docs repo, since they were added by gitbook via drag & drop and most of them were not referenced anywhere.

maciejwitowski commented 4 months ago

After this branch is merged I'm gonna switch docs website to use main.