DocsGen

⚠ Deprecated

Please see Docs UI for the updated docs.eosnetwork.com user interface

DocsGen is the tool used to build the EOS documentation. It consists of a set of scripts and configuration files to generate the EOS Web Documentation Portal. The goal of this project is to create a single web portal linking together documentation across the EOS Network code repositories. This portal will make an effort to make it easy to build and maintain EOS projects, according to the following objectives:

• Single place EOS documentation
• Unified presentation of documentation
• Single navigation hierarchy covering documentation
• Consistent UI for documentation

System Design

In a nutshell, a shell script clones a git repository, and puts the content into a staging server. The staging server builds the content into the documentation you see on the website. The current system uses Docusaurus to convert markdown into HTML, power navigation, and manage versions.

graph LR;
    subgraph prod1 [Production]
    Webserver;
    end
    subgraph stag1 [DocService]
    Docusaurus-->HTML;
    HTML-->|scp|Webserver;
    end
    subgraph github [GitHub]
    Repo1-->|clone|Docusaurus;
    Repo2-->|clone|Docusaurus;
    Repo3-->|clone|Docusaurus;
    end

Testing utilizes Cypress, while search is powered by algolia.

Coverage

Documentation

For information on how to generate content, update the site navigation, update the UX presentation, production setup, and testing, visit the documentation section.