From ec34fc6870836f389ec021c53341a619a20bc0f1 Mon Sep 17 00:00:00 2001 From: Robby Findler Date: Sat, 18 Aug 2012 09:03:35 -0500 Subject: [PATCH] add a note about how to build documentation to the planet documentation building step --- collects/planet/planet.scrbl | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/collects/planet/planet.scrbl b/collects/planet/planet.scrbl index 47f6bc649b..3877144f7d 100644 --- a/collects/planet/planet.scrbl +++ b/collects/planet/planet.scrbl @@ -554,6 +554,11 @@ numbers in documentation for @|PLaneT| packages, and @other-manual['(lib "scribblings/scribble/scribble.scrbl")] for instructions on how to write Scribble documentation. +When testing your documentation, set up a development link and use +@centered{@tt{raco setup -P }} +with arguments based on the development link to build and +test your documentation. + @italic{Note:} Always use @racket[this-package-in] in @racket[for-label] bindings when documenting @|PLaneT| packages, and always use the bindings in @racketmodname[planet/scribble] rather than @racketmodname[scribble/manual].