Skip to content

Commit 8299130

Browse files
authored
docs: add some more information for jsdoc (#892)
1 parent f80ff16 commit 8299130

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ frontend in a development mode that connects to the production API.
4646

4747
- Clone this repo
4848
- Install Deno (https://deno.land/#installation)
49-
- Add the following to your `/etc/hosts` file. If you're using WSL, you'll also need to update the `hosts` file located at `C:\Windows\System32\drivers\etc\hosts`.
49+
- Add the following to your `/etc/hosts` file. If you're using WSL, you'll also
50+
need to update the `hosts` file located at
51+
`C:\Windows\System32\drivers\etc\hosts`.
5052
```
5153
127.0.0.1 jsr.test
5254
127.0.0.1 api.jsr.test
@@ -71,7 +73,9 @@ making changes to the API.
7173
- Clone this repo
7274
- Install Deno (https://deno.land/#installation)
7375
- Install Rust (https://rustup.rs/)
74-
- Add the following to your `/etc/hosts` file. If you're using WSL, you'll also need to update the `hosts` file located at `C:\Windows\System32\drivers\etc\hosts`.
76+
- Add the following to your `/etc/hosts` file. If you're using WSL, you'll also
77+
need to update the `hosts` file located at
78+
`C:\Windows\System32\drivers\etc\hosts`.
7579
```
7680
127.0.0.1 jsr.test
7781
127.0.0.1 api.jsr.test

frontend/docs/writing-docs.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@ description: This guide explains how to write documentation for JSR packages.
44

55
Writing documentation is vital for the success of a package. JSR makes it very
66
easy for package authors to have great documentation, because it generates
7-
documentation based on the JSDoc comments in the package source code.
7+
documentation based on the JSDoc-like comments in the package source code.
8+
9+
The supported JSDoc-style features and tags are shared with Deno, and are listed
10+
out on
11+
[Deno's Supported JSDoc tags](https://docs.deno.com/runtime/reference/cli/doc/#supported-jsdoc-tags)
12+
page.
813

914
This generated documentation is displayed on the package page. This
1015
documentation will also be shown to users in their editor in form of completions

0 commit comments

Comments
 (0)