Skip to content

Commit

Permalink
Instructions for previewing JSDoc info and examples (#1332)
Browse files Browse the repository at this point in the history
Co-authored-by: Jo Franchetti <[email protected]>
  • Loading branch information
philhawksworth and thisisjofrank authored Jan 14, 2025
1 parent 8bb9b71 commit dc6d3ff
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,26 @@ deno task reference
This will generate the reference docs, and you can use the `serve` or `build`
tasks.

The API reference documentation is generated from type definitions in the
[Deno source code](https://github.com/denoland/deno). The API reference content
can be edited by modifying the JSDoc comments in the corresponding `d.ts` files
in the Deno source code. Once merged, the changes will be reflected in the API
reference documentation when the Deno documentation site is next updated.

### Previewing API reference changes

In order to preview changes to the API reference, take the following steps:

1. Make changes to the JSDoc comments in the Deno source code
1. [Build the Deno CLI locally](https://docs.deno.com/runtime/contributing/building_from_source/),
including your JSDoc changes
1. For convenience, create an alias of `d_deno` to point to your local build of
the Deno CLI (typically in the `target/debug/deno` directory of your CLI
repo)
1. Generate the reference docs from your local build of the Deno CLI by running
in the root directory `d_deno task reference`
1. Run the `deno task serve` command in the root directory to see the changes

## Versioning docs content

Philosophically, we want to maintain as few discrete versions of the
Expand Down

0 comments on commit dc6d3ff

Please sign in to comment.