waku.org/README.md

• Description
• How to Run Locally
• Continuous Integration
• Format & spelling checks
• Configuration
• Customization

Description

This repository contains the content of your documentation website.

How to Run Locally

• Please keep this repo clean and for markdown content ONLY
• In case you have any issue with rendering, how website looks, etc, please file an issue on logos website builder.

Continuous Integration

• master branch is deployed to https://waku.org by CI.
• develop branch is deployed to https:/dev.waku.org by CI.

Format & spelling checks

Format and spelling checks are done via npm commands.

Installation:

yarn

Configuration

Edit the docusaurus.config.js file in the repository's root directory, and update the value of the businessUnit field in presets section; below is a list of valid values:

• Logos
• Codex
• Waku

Example:

presets: [
  [
    '@acid-info/logos-docusaurus-preset',
    {
      businessUnit: 'Codex',
    },
  ],
],

This is probably enough in most cases, as the Logos plugins will fill in other configurations related to the specified business unit. If you find any error in the information coming from Logos Plugins, please head over to Logos Docusaurus Plugins and create an issue.

Customization

You can find the instructions on adding more documentation sections, localization, and versioning on the Docusaurus website.

Note that theme customization is limited; for further instructions on customizing your theme, head over to Logos Docusaurus Theme.