suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation contribution guide

Browse Source
This commit is contained in:
Sorawee Porncharoenwase 2020-05-02 19:31:37 -07:00 committed by Matthew Flatt
parent c59f72f101
commit 9465cbd7e6
2 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
build.md
View File

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

12
pkgs/racket-build-guide/contribute.scrbl
View File

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