From e202cbe3de12cf2ca6380b24010eecfc1ae729bc Mon Sep 17 00:00:00 2001
From: Alan Orth <alan.orth@gmail.com>
Date: Sat, 29 Jan 2022 17:15:42 +0300
Subject: [PATCH] Add README-dev.md

I need to start collecting and organizing documentation for various
technical workflows here. For example:

- Adding a new schema element
- Adding a new schema extension
- Updating controlled vocabularies
- Updating the documentation site layout

Etc...
---
 README-dev.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README-dev.md

diff --git a/README-dev.md b/README-dev.md
new file mode 100644
index 00000000..638c6a37
--- /dev/null
+++ b/README-dev.md
@@ -0,0 +1,32 @@
+# Technical Documentation
+This document provides technical information about various workflows related to updating and editing the schema and documentation site.
+
+## General Requirements
+
+- Python 3.7+
+- Node.js 12+ and NPM
+
+## Python Setup
+Create a Python 3 (3.7+) virtual environment and install the requirements:
+
+```console
+$ python3 -m venv virtualenv
+$ source virtualenv/bin/activate
+$ pip install -r requirements.txt
+```
+
+Then run the utility scripts to parse the schemas:
+
+```console
+$ ./util/generate-hugo-content.py -i ./data/iseal-core.csv --clean -d
+$ ./util/generate-hugo-content.py -i data/fsc.csv -d
+```
+
+## Node.js Setup
+To generate the HTML documentation site:
+
+```console
+$ cd site
+$ npm install
+$ npm run build
+```