mirror of
https://github.com/logos-storage/logos-storage-docs.git
synced 2026-01-02 13:23:07 +00:00
b405bd1973
* Add links to the existing guides on Run Codex page * Add Codex/Geth bootstrap nodes and endpoints to the Testnet page * Initial version of the Quick start page * Fix bad links on Quick start page * Install dependencies in Quick start guide * minor language upgrades * Copies over disclaimer from testnet-starter repo * octet-stream type for upload * Add Disclaimer Codex page to the sidebar * Adjust Quick start guide to auto-detect platform and architecture --------- Co-authored-by: Ben <thatbenbierens@gmail.com>
Codex documentation
Welcome to Codex documentation.
Codex is a decentralised data storage platform that provides exceptionally strong censorship resistance and durability guarantees.
Run and build
For documentation we use VitePress, which is Vue-powered static site generator built on top of Vite.
To run site locally, we should clone repository and run the following command
npm run docs:dev
Detailed guide
-
Using nvm
# nvm curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash # Node 22 nvm install 22 nvm use 22 # Check node --version v22.6.0 -
Clone repository
git clone https://github.com/codex-storage/codex-docs cd codex-docs -
Start a local dev server with instant hot updates
# Local npm run docs:dev # Expose npm run docs:dev -- --host -
npm run docs:build # .vitepress/dist
Contribute
Please check VitePress documentation for more details about customizations.
Process
- Create a fork
- Create a custom branch in your fork
- Add your contribution
- Make a PR to the upstream repository
Project structure
learn- All information to learn about Codexnetworks- Codex networks related informationdevelopers- Codex development process and guides