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, install dependencies and run the following command

npm run docs:dev

Detailed guide

1. Install node 20 or above

   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

2. Clone repository

   git clone https://github.com/codex-storage/codex-docs
   cd codex-docs

3. Install dependencies

   npm install

4. Start a local dev server with instant hot updates

   # Local
   npm run docs:dev
   
   # Expose
   npm run docs:dev -- --host

5. Build the site

   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 Codex
• networks - Codex networks related information
• developers - Codex development process and guides

Internationalization

We are using built-in i18n features for Internationalization support.

In order to add a new language version of the docs it is required

1. Create a folder with a name of the two letter language code - ko for Korean, please check List of ISO 639 language codes.

2. Copy and translate required pages. It make sense to use English pages as a source as it is the primary language. Pages are located inside the repository sub-folders

   • codex
   • developers
   • learn
   • networks

   After translation, we will have a new folder with all sub-folders

   ko
   ├── codex
   ├── developers
   ├── learn
   └── networks
   

3. If you need to translate images, they are located inside a public folder. After translation, add a language suffix to the language specific file, for example public/learn/architecture-ko.png.

   Then, update the docs to use a language specific image.

4. Add new language to the site config file - .vitepress/config.mts

   // Korean
   ko: {
     label: '한국어',
     lang: 'ko-KP',
     link: '/ko',
     themeConfig: {}
   }

   • label - Native language name from List of ISO 639 language codes
   • lang - <Language code>-<Country code>
   • link - link to the index document located in the language specific folder
   • themeConfig - contains translation of the site elements like Nav/Side bar, etc.

After performed changes, we should have a documentation site in a newly added language.