Public Documentation Scripts

This directory contains helper scripts used for generating and serving the public-facing documentation site rabs-public.

publicpush.js

publicpush.js creates a stripped-down, code-sanitised version of the project documentation and launches it with Docsify.

Usage

node ./scripts/publicpush.js

Process

By default, the script outputs to a sibling directory named rabs-public and will:

1. Clean the destination – remove all existing files except the .git directory.
2. Copy documentation – replicate every Markdown file while removing source code. Only lines containing the marker // {K} are retained to provide high-level context.
3. Generate navigation – create index.html and a dynamic _sidebar.md for Docsify.
4. Commit & push – automatically commit any changes in rabs-public and push to its remote.
5. Serve locally – launch the docs site at http://localhost:3005 for quick review.