Skip to content

docs: add generated reference site - #95

Merged
tetsuo-cpp merged 1 commit into
canonfrom
docs/add-reference-site
Aug 15, 2026
Merged

docs: add generated reference site#95
tetsuo-cpp merged 1 commit into
canonfrom
docs/add-reference-site

Conversation

@tetsuo-cpp

@tetsuo-cpp tetsuo-cpp commented Aug 13, 2026

Copy link
Copy Markdown
Owner

Summary

  • add an opt-in Sphinx/MyST/Furo reference site with a concise landing page and handwritten language and GPT-2 demo guides
  • generate portable Forth dialect documentation directly from TableGen without Hugo-specific output
  • generate a linked C++ API and source reference with Doxygen
  • expose the complete site through the docs-warpforth CMake target and validate it in CI

Documentation remains disabled in normal builds unless WARPFORTH_ENABLE_DOCS=ON.

Validation

  • cmake --build build-docs --target docs-warpforth
  • cmake --build build-docs --target check-warpforth — 115/115 tests passed
  • rendered home, language, dialect, demo, and C++ API pages inspected through the documentation portal
  • PR build-and-test workflow passed before the squash

@tetsuo-cpp
tetsuo-cpp force-pushed the docs/add-reference-site branch from 53f25fb to 5ae365c Compare August 13, 2026 05:14
@tetsuo-cpp tetsuo-cpp changed the title Add generated documentation site docs: add generated documentation site Aug 13, 2026
@tetsuo-cpp
tetsuo-cpp force-pushed the docs/add-reference-site branch from 5ae365c to 42d79cd Compare August 13, 2026 05:18
Comment thread README.md Outdated
Add an opt-in Sphinx/MyST/Furo site with a concise landing page and
handwritten language and demo guides.

Generate portable Forth dialect documentation directly from TableGen and a
linked C++ API/source reference with Doxygen. Expose the complete site through
the docs-warpforth target and validate it in CI.
@tetsuo-cpp
tetsuo-cpp force-pushed the docs/add-reference-site branch from 247239a to 18113a2 Compare August 15, 2026 13:57
@tetsuo-cpp tetsuo-cpp changed the title docs: add generated documentation site docs: add generated reference site Aug 15, 2026
@tetsuo-cpp
tetsuo-cpp merged commit 9ac0dc2 into canon Aug 15, 2026
1 check passed
@tetsuo-cpp
tetsuo-cpp deleted the docs/add-reference-site branch August 15, 2026 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant