vrr/open-notebook
2
0
Fork 0
mirror of https://github.com/lfnovo/open-notebook.git synced 2026-07-23 22:55:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
open-notebook/scripts
History
Exact
Luis Novo faa2b16e77
docs: codify the release confidence process with executable tooling (#1052) 
Captures the process designed and executed for v1.11.0 so every future
release reproduces it:

- .github/RELEASE_PROCESS.md v2: changelog audit, risk-based test
  matrix (buckets A/B/C), the Docker image gate, fix-loop re-test
  policy, CI-based publishing path, communication structure with a
  mandatory credits section, retro, and the gotchas that cost
  iterations this cycle
- ADR-005: why releases now pass a risk-based confidence process gated
  on the real image, with the v1.11.0 evidence (bugs the unit suite
  could not catch: SEARCH-index ORDER BY 500, credential clear no-op)
- scripts/release-test/: the harness built during v1.11.0 —
  fresh-install + upgrade gate (release-image-test.sh) and the
  browsable RC stack with optional dev-data copy (rc-stack.sh), plus
  compose/nginx encoding the API_URL, host.docker.internal and
  SurrealDB import learnings
- make release-test / release-stack / release-stack-down targets
2026-07-11 16:56:14 -03:00
..
release-test docs: codify the release confidence process with executable tooling (#1052) 2026-07-11 16:56:14 -03:00
check_md_links.py docs: restructure documentation around AGENTS.md, VISION.md and decision records (#1032) 2026-07-10 15:33:19 -03:00
export_docs.py Enhance export_docs.py with Table of Contents feature (#865) 2026-06-13 08:52:26 -03:00
README.md chore: export docs for custom gpt 2025-10-18 20:26:11 -03:00
wait-for-api.sh fix(docker): make wait-for-api.sh POSIX and enforce LF line endings (#586) (#598) 2026-04-19 15:49:11 -03:00

README.md

Scripts Documentation

export_docs.py

Consolidates markdown documentation files for use with ChatGPT or other platforms with file upload limits.

What It Does

  • Scans all subdirectories in the docs/ folder
  • For each subdirectory, combines all .md files (excluding index.md files)
  • Creates one consolidated markdown file per subdirectory
  • Saves all exported files to doc_exports/ in the project root

Usage

# Using Makefile (recommended)
make export-docs

# Or run directly with uv
uv run python scripts/export_docs.py

# Or run with standard Python
python scripts/export_docs.py

Output

The script creates doc_exports/ directory with consolidated files like:

  • getting-started.md - All getting-started documentation
  • user-guide.md - All user guide content
  • features.md - All feature documentation
  • development.md - All development documentation
  • etc.

Each exported file includes:

  • A main header with the folder name
  • Section headers for each source file
  • Source file attribution
  • The complete content from each markdown file
  • Visual separators between sections

Example Output Structure

# Getting Started

This document consolidates all content from the getting-started documentation folder.

---

## Installation

*Source: installation.md*

[Full content of installation.md]

---

## Quick Start

*Source: quick-start.md*

[Full content of quick-start.md]

---

Notes

  • The doc_exports/ directory is gitignored and safe to regenerate anytime
  • Index files (index.md) are automatically excluded
  • Files are sorted alphabetically for consistent output
  • The script handles subdirectories only (ignores files in the root docs/ folder)