Skip to content

Documentation of the various architectures used in Hollowverse

License

Notifications You must be signed in to change notification settings

hollowverse-archive/architecture

Repository files navigation

Hollowverse Architectures Build Status

This repository contains documentation of the various architectures used in Hollowverse.

Architectures


Contributing and making edits

File and folder structure

The architectures are documented in /architectures. Each markdown file describes one architecture. Inside /architectures, there's a folder named /diagrams, which contains the PlantUML (.puml) files as well as the svg images which are generated from the puml files.

The svg images are referenced inside the markdown files to illustrate the documented architectures.

Editing files

To get started

  1. Clone this repo
  2. cd into it
  3. yarn install

Now feel free to edit stuff. We recommend using VS Code and installing the PlantUML extension so that you can preview the PlantUML files as you edit them.

When you're done, run

yarn build

...to build the svg files from the puml files.


If you need help or wanna get in touch...

About

Documentation of the various architectures used in Hollowverse

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published