Skip to content

A repo to collaborate on technically accurate definitions for Orcfax domain components

Notifications You must be signed in to change notification settings

orcfax/glossary

Repository files navigation

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:

  • nodejs (required)
  • pnpm (optional)

Pre-commit is used for tidying:

  • pre-commit (required)
  • markdownlint-cli (optional)
  • prettier (optional for markdown auto-fixes)

Helpful command line tools

  • just - "handy way to save and run project-specific commands"

Run just for suggestions.

Contributing

See the contributing guidelines.

About

A repo to collaborate on technically accurate definitions for Orcfax domain components

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •