Skip to content

docs: add generated documentation site - #95

Open
tetsuo-cpp wants to merge 2 commits into
canonfrom
docs/add-reference-site
Open

docs: add generated documentation site#95
tetsuo-cpp wants to merge 2 commits into
canonfrom
docs/add-reference-site

Conversation

@tetsuo-cpp

Copy link
Copy Markdown
Owner

Summary

  • add an opt-in Sphinx/MyST documentation site using LLVM's Furo theme
  • stage README.md as the single-source home page and port the existing language and GPT-2 documentation
  • generate the complete Forth dialect reference from TableGen and handwritten C++ API/source documentation with Doxygen
  • expose one docs-warpforth CMake target and build it in CI

Validation

  • cmake --build build-docs --target docs-warpforth
  • cmake --build build-docs --target check-warpforth (115/115 tests passed)
  • cmake --build build-docs --target check-format
  • cmake --build build-docs --target check-clang-tidy
  • browser verification of the home, language, dialect, demo, and C++ API pages

@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
@tetsuo-cpp

Copy link
Copy Markdown
Owner Author

/gpu-test

Comment thread README.md Outdated
@tetsuo-cpp

Copy link
Copy Markdown
Owner Author

/gpu-test

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