From 6da82230e864184dd589ff0299d923b02270d8a6 Mon Sep 17 00:00:00 2001
From: John Bampton <jbampton@gmail.com>
Date: Fri, 30 Dec 2022 11:14:12 +1000
Subject: [PATCH] Add more building documentation

---
 CONTRIBUTING.md | 13 +++++++++++++
 tasks/doc.rake  |  3 +++
 2 files changed, 16 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f09f35cbe..b0985530c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -114,3 +114,16 @@ language itself. Please note the following hints for your Ruby code:
 mruby is currently targeting to execute Ruby code which complies to ISO/IEC
 30170:2012 (<https://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579>),
 unless there's a clear reason, e.g. the latest Ruby has changed behavior from ISO.
+
+## Building documentation
+
+### mruby API
+
+- [YARD](https://yardoc.org/) - YARD is a documentation generation tool for the Ruby programming language
+- [yard-mruby](https://github.com/sagmor/yard-mruby) - Document MRuby sources with YARD
+- [yard-coderay](https://github.com/sagmor/yard-coderay) - Adds coderay syntax highlighting to YARD docs
+
+### C API
+
+- [Doxygen](https://www.doxygen.nl/) - Generate documentation from source code
+- [Graphviz](https://graphviz.org/) - Graphviz is open source graph visualization software
diff --git a/tasks/doc.rake b/tasks/doc.rake
index a6135bb82..b9b96d7c2 100644
--- a/tasks/doc.rake
+++ b/tasks/doc.rake
@@ -11,6 +11,9 @@ namespace :doc do
     rescue
       puts "ERROR: To generate yard documentation, you should install yard-mruby gem."
       puts "  $ gem install yard-mruby yard-coderay"
+      puts "https://yardoc.org/"
+      puts "https://github.com/sagmor/yard-mruby"
+      puts "https://github.com/sagmor/yard-coderay"
     end
   end