From 9465cbd7e66b2307be7d83665627b5f4fe2bb406 Mon Sep 17 00:00:00 2001 From: Sorawee Porncharoenwase Date: Sat, 2 May 2020 19:31:37 -0700 Subject: [PATCH] Update documentation contribution guide --- build.md | 11 ++++++++--- pkgs/racket-build-guide/contribute.scrbl | 12 ++++++++---- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/build.md b/build.md index e425ea378a..e980a8e85d 100644 --- a/build.md +++ b/build.md @@ -828,9 +828,14 @@ that process faster by keeping a few guidelines in mind: * Include new or updated documentation as appropriate. - Note that the Racket reference is in - `"pkgs/racket-doc/scribblings/reference"`, and documentation for other - libraries are also sometimes in a separate `"-doc"` package. + To locate a documentation (Scribble) source file, visit the current + documentation in a browser, and click at the page heading. A box will + appear with a URL to a documentation source. Note that while it is + likely that the documentation source will not be the file that you + want to edit exactly, it should give you a rough idea for where it is. + Particularly, the Racket reference is in + `"pkgs/racket-doc/scribblings/reference"`, and the Racket guide is in + `"pkgs/racket-doc/scribblings/guide"`. When adding to a library or extending an existing binding’s behavior, be sure to include a `history` note in the documentation to record the diff --git a/pkgs/racket-build-guide/contribute.scrbl b/pkgs/racket-build-guide/contribute.scrbl index d15f158550..036195109d 100644 --- a/pkgs/racket-build-guide/contribute.scrbl +++ b/pkgs/racket-build-guide/contribute.scrbl @@ -157,10 +157,14 @@ make that process faster by keeping a few guidelines in mind: @item{Include new or updated documentation as appropriate. - Note that the Racket reference is in - @filepath{pkgs/racket-doc/scribblings/reference}, and - documentation for other libraries are also sometimes in a - separate @filepath{-doc} package. + To locate a documentation (Scribble) source file, + visit the current documentation in a browser, and click at the page heading. + A box will appear with a URL to a documentation source. + Note that while it is likely that the documentation source will not be the file + that you want to edit exactly, it should give you a rough idea for where it is. + Particularly, the Racket reference is in + @filepath{pkgs/racket-doc/scribblings/reference}, and the Racket guide is in + @filepath{pkgs/racket-doc/scribblings/guide}. When adding to a library or extending an existing binding's behavior, be sure to include a @racket[history] note in the