orcfax / glossary

A repo to collaborate on technically accurate definitions for Orcfax domain components
http://glossary.orcfax.io
1 stars 0 forks source link

Orcfax glossary

Where definitions come to be immortalized. End of discussion.

For internal and external consumption.

To view

The pretty version is at https://glossary.orcfax.io/

Repo organisation

The top level looks a bit like

$tree -L 1
.
├── builder           # Our homebrew builder
├── content           # All the definitions
├── CONTRIBUTING.md
├── docs              # generated output html
├── flake.lock
├── flake.nix
├── justfile          # All the helpful commands
├── README.md
├── templates         # Turtle templates
└── TODOs.md

Dependencies

The builder is a node repo:

Pre-commit is used for tidying:

Helpful command line tools

Run just for suggestions.

Contributing

See the contributing guidelines.