From 21b357607d564ebcd0fee1d59203c768ad3d585b Mon Sep 17 00:00:00 2001 From: ZDDC Date: Tue, 19 May 2026 10:36:09 -0500 Subject: [PATCH] =?UTF-8?q?docs:=20consolidate=20site=20to=20two=20tools?= =?UTF-8?q?=20=E2=80=94=20archive=20+=20browse?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit We're consolidating ZDDC functionality into two tools rather than the four previously advertised. Transmittal Creator, Document Classifier, and Markdown Editor are removed from the public site; their workflows are absorbed into Browse (file-tree navigator with in-place markdown editing, on-demand DOCX/HTML/PDF download, file management surface for classification and transmittal preparation). Changes: - Dropdown menu (both index + reference): two entries (Archive Browser, Browse). - index.html "Try the tools": two tool cards. Hero + intro copy reflect the two-tool framing. - index.html "Install on your server": baked-in tool list collapses to archive + browse + index; the slash/no-slash routing convention is referenced rather than re-listing per-folder tool mappings. - index.html "Local: just download": two download links. - reference.html § 1 intro: "two tools" wording. - reference.html § 9 project layout: working/ description now points at the browse tool for markdown editing rather than the retired mdedit. - reference.html § 10 Tools: two cards with refreshed descriptions that match the consolidated scope. - README.md: tool list updated for new contributors. federal.html, css/, and js/ have no tool-product references to update; their "transmittal" mentions are the document-flow concept and stay as-is. --- README.md | 8 +++--- index.html | 71 ++++++++++++++------------------------------------ reference.html | 47 ++++++++++----------------------- 3 files changed, 37 insertions(+), 89 deletions(-) diff --git a/README.md b/README.md index 32d9cb3..44984ec 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,10 @@ files: Plus `css/`, `js/`, `img/` for shared styles and assets. This repo intentionally does **not** contain release artifacts. The -ZDDC tools (`archive`, `transmittal`, `classifier`, `mdedit`, -`landing`) and the `zddc-server` binary are built from the source -repo at and deployed to the live -site by its build pipeline. They live on the deploy host under +ZDDC tools (`archive`, `browse`, `landing`) and the `zddc-server` +binary are built from the source repo at + and deployed to the live site by +its build pipeline. They live on the deploy host under `/srv/zddc/releases/`, never in this repo's git history. ## Preview locally diff --git a/index.html b/index.html index fbbac77..14eef87 100644 --- a/index.html +++ b/index.html @@ -4,11 +4,11 @@ ZDDC — Zero Day Document Control - + - + @@ -66,17 +66,9 @@ Archive Browser - - - Transmittal Creator - - - - Document Classifier - - - - Markdown Editor + + + Browse @@ -91,7 +83,7 @@

Zero Day Document Control

-

A file-naming convention and a small set of single-file HTML tools for managing project deliverables. Self-contained, offline-capable, dependency-free.

+

A file-naming convention and two single-file HTML tools — archive and browse — for managing project deliverables. Self-contained, offline-capable, dependency-free.

@@ -100,7 +92,7 @@

What is it?

ZDDC is a convention, not a platform. Every deliverable's filename encodes its tracking number, revision, status, and title; every transmittal folder is date-prefixed and self-describing. A plain shared folder becomes a fully searchable, auditable information-management system — no server, no database, no software required to read the archive.

-

The four tools below are optional interfaces around this structure. Each is a single self-contained HTML file that works two ways: open it locally and point it at a folder on your disk, or put it behind any web server (including the optional zddc-server described below) and use it over the network. Same on-disk layout either way.

+

The two tools below are optional interfaces around this structure. Each is a single self-contained HTML file that works two ways: open it locally and point it at a folder on your disk, or put it behind any web server (including the optional zddc-server described below) and use it over the network. Same on-disk layout either way.

Read the full specification →

@@ -112,7 +104,7 @@
Archive Browser
-
Browse, search, and filter your project folder. Group by transmittal; filter by tracking number, revision, status, or free text. Export selections as ZIP.
+
Search the formal record. Filter by tracking number, discipline, revision, status, or free text; group rows by transmittal to see each deliverable's lifecycle; export the current selection as a ZIP. Read-only — the archive is preserved as-issued.
stable beta @@ -121,32 +113,12 @@
-
Transmittal Creator
-
Fill in metadata, drag in files, publish a self-contained HTML transmittal record with SHA-256 checksums. Optional digital signatures. The published file is the transmittal record.
+
Browse
+
File-tree navigator for the whole project. Edit markdown in place with live preview, YAML front matter, and a table of contents pane; download any markdown source as DOCX, HTML, or PDF on demand; classify inbound files to ZDDC names, draft transmittals, and manage the project tree end-to-end.
- stable - beta - alpha -
-
- -
-
Document Classifier
-
Spreadsheet-like interface for bulk-renaming files into ZDDC format. Copy/paste with Excel. Point it at a folder, fill in the columns, save all at once.
-
- stable - beta - alpha -
-
- -
-
Markdown Editor
-
Browser-based markdown editor with live preview, YAML front matter, and table of contents. Direct local file access via the File System Access API.
-
- stable - beta - alpha + stable + beta + alpha
@@ -207,22 +179,19 @@ Role definitions cascade like everything else; a child .zdd

Server: just run zddc-server

-

The binary has the current-stable build of all five tools baked in at compile time. They appear automatically at the right paths in the served tree:

+

The binary has the current-stable build of both tools baked in at compile time. They appear automatically at the right paths in the served tree:

    -
  • archive.html and browse.html at every level (root, project, archive, party)
    • -
  • mdedit.html in any working/ directory and its subtree
    • -
  • transmittal.html in any staging/ directory and its subtree
    • -
  • classifier.html in any working/, staging/, or archive/<party>/incoming/ subtree
    • -
  • mdl.table.html at every archive/<party>/ — the per-party Master Deliverables List, served from a built-in default schema unless the party's .zddc declares a custom one
    • +
  • archive.html at every archive/ path — the read-only search-and-export view of the formal record
    • +
  • browse.html at every directory (the slash form of any path) — the file-tree navigator, in-place markdown editor, and inbound-file handling surface
  • index.html (the project picker) at the deployment root
-

Folder names are case-insensitive — Working/, working/, and WORKING/ all match the working/ rule.

+

Which tool serves at a given URL is decided by the .zddc cascade — the embedded defaults map archive/ subtrees to the archive tool and everything else to browse, but operators can override per folder via default_tool:. Folder names are case-insensitive — Working/, working/, and WORKING/ all match the same rule.

./zddc-server

No flags needed for a quick start. The served tree defaults to the current working directory; the listener defaults to https://localhost:8443/ with a self-signed certificate. --root, --addr, and --tls-cert / --tls-key override each. --help prints the full flag list.

To override a tool at any path: drop a real .html file there — that file wins over the baked-in version. To pin a different version, write an apps: entry in any .zddc file along the path:

# <project>/.zddc
 apps:
-  classifier: stable     # or beta / alpha / v0.0.4 / v0.0 / v0
+  browse: stable         # or beta / alpha / v0.0.4 / v0.0 / v0
   archive: https://my-fork.example/archive.html

URL sources are fetched once and cached in <ZDDC_ROOT>/_app/. To force a re-fetch, delete the cache file. Closer-to-leaf .zddc entries override parent ones.

@@ -232,9 +201,7 @@ apps:

No server, no install — open in any modern browser.

Right-click → Save As. Each tool is a self-contained HTML file with everything inlined; works from file:// or any static host.

diff --git a/reference.html b/reference.html index eb639a8..6d228a8 100644 --- a/reference.html +++ b/reference.html @@ -44,17 +44,9 @@ Archive Browser - - - Transmittal Creator - - - - Document Classifier - - - - Markdown Editor + + + Browse
@@ -104,7 +96,7 @@

Together, these two rules mean a plain folder on any shared drive becomes a fully searchable, auditable information management system. No server, no database, no software required to read the archive.

Because every deliverable is self-describing — its identity, revision, and status encoded in the filename itself — the convention works across organisational boundaries without requiring a shared platform. A project adopting ZDDC can extend the same convention to its clients, subcontractors, vendors, and any other party in the project ecosystem. Each party maintains their own archive; the shared naming convention makes every archive mutually intelligible. Adoption can be voluntary or contractually required. The result is a globally scalable, distributed information management system built on nothing more than agreed file naming and standard directory structures.

-

The four tools implement interfaces around this structure — but they're optional. The structure works without them, and any party can participate using only their file browser.

+

The two tools below implement interfaces around this structure — but they're optional. The structure works without them, and any party can participate using only their file browser.

Convention harmonization. The convention is designed to be applied at multiple organisational scopes simultaneously — corporate, client, project, department — and the code registries at each scope should be harmonized so they do not conflict. A corporate discipline code such as HR (Human Resources) does not exist at the project level, so there is no clash. But a code that means one thing corporately and something different on a project would create ambiguity in a unified archive. The ideal is that conventions flow down: corporate establishes the master code registry, projects inherit it and extend it only where gaps exist, and no code is reused with a different meaning at a lower scope.

@@ -1011,8 +1003,9 @@ project/ working/ ← Where staff draft. Each person has their own subfolder here (named by email) and works on documents in private until they're ready to - issue. Markdown opens in mdedit; arbitrary - files are dropped in via the browse tool. + issue. The browse tool handles everything here + — file management, in-place markdown editing + with live preview, on-demand format conversion. staging/ ← The "about to issue" lane. A folder in here declares a planned outbound transmittal: its @@ -1111,35 +1104,23 @@ project/

10. Tools

-

Four single-file HTML applications — each is complete and self-contained. Save them locally and they work forever, without internet, without updates, without a subscription.

+

Two single-file HTML applications — each is complete and self-contained. Save them locally and they work forever, without internet, without updates, without a subscription. Together they cover the full ZDDC workflow: archive for searching and exporting the formal record; browse for navigating, editing, and managing the project tree.

Archive Browser
-
Browse, search, filter your project folder. Filter by tracking number, discipline, revision, status, or free text. Group by transmittal. Download selected files as ZIP.
+
Search and filter the formal record. Filter by tracking number, discipline, revision, status, or free text. Group rows by transmittal to see the lifecycle of any deliverable. Download the current selection as a ZIP. Read-only — the archive is preserved as-issued.
Open Archive Browser
 - -
Transmittal Creator
-
Fill in metadata, drag in files, publish a self-contained HTML transmittal record with SHA-256 checksums. Supports digital signatures. The published file IS the transmittal record.
-
Create Transmittal
- - - -
Document Classifier
-
Spreadsheet-like interface for bulk-renaming files to ZDDC format. Copy/paste with Excel. Point it at a folder, fill in the columns, save all at once.
-
Run Classifier
- - - -
Markdown Editor
-
Browser-based markdown editor with live preview, YAML front matter support, and table of contents. Direct local file access via File System Access API.
-
Open Editor
+ +
Browse
+
File-tree navigator for the project. Edit markdown in place (live preview, YAML front matter pane, table of contents). Download any markdown source as DOCX, HTML, or PDF on demand. Drop in files, classify them to ZDDC names, draft transmittals, and prepare deliverables — every workflow happens here.
+
Open Browse
-

Local directory access relies on the Chromium-based browser File System Access API. It does not work in Firefox or Safari.

+

Local directory access relies on the Chromium-based browser File System Access API. It does not work in Firefox or Safari. Run both tools through zddc-server for any browser, network access, and ACL enforcement.