Introduction
Welcome to the comprehensive developer's guide for the Spec-Up-T system. This documentation will guide you through contributing to Spec-Up-T, whether you're adding features, fixing bugs, or creating custom extensions for your specific needs.
GitHub Repositories
There are currently two repositories that contain three components.
Publishing to GitHub and npm
This guide describes the recommended workflow for publishing packages to GitHub and npm.
Web of Repo's
Work in progress.
Dependencies
This page describes the main runtime and build-time dependencies used by the spec-up-t package.
Setting Up Environment
2 items
Specref.org
3 items
Starter Pack Architecture
This document explains how the create-spec-up-t package works, its relationship with the main spec-up-t package, and how to maintain it.
Scripts
5 items
Serve GitHub Pages site on a custom domain
This document describes how to configure GitHub Pages to serve the repository at a custom domain (example: glossary.trustoverip.org).
Create a Zenodo DOI
This page explains how to assign a Zenodo DOI to a Spec-Up-T specification.
TREF vs XREF
This document explains the differences between xref (external reference) and tref (transcluded reference) in the Spec-Up-T specification generation system.
Inside index.html
This document provides a comprehensive inventory of what is stored in the final index.html file generated by Spec-Up-T.
Spec-Up-T Editor
Table of Contents
Testing Features That Span GitHubUi and spec-up-t
This guide explains how to test changes that span both the GitHubUi (browser UI) and spec-up-t (Node.js backend) repositories. We use the customizable freeze/snapshot label feature as a concrete example, but this testing pattern applies to any feature that requires coordination between the two repos.
Testing Guide for Spec-Up-T
Welcome to the comprehensive testing guide for Spec-Up-T! This document will help you understand how to test the Spec-Up-T system, set up testing environments, write effective tests, and contribute to the project's quality assurance.