Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add some more information for jsdoc #892

Merged
merged 1 commit into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ frontend in a development mode that connects to the production API.

- Clone this repo
- Install Deno (https://deno.land/#installation)
- 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`.
- 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`.
```
127.0.0.1 jsr.test
127.0.0.1 api.jsr.test
Expand All @@ -71,7 +73,9 @@ making changes to the API.
- Clone this repo
- Install Deno (https://deno.land/#installation)
- Install Rust (https://rustup.rs/)
- 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`.
- 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`.
```
127.0.0.1 jsr.test
127.0.0.1 api.jsr.test
Expand Down
7 changes: 6 additions & 1 deletion frontend/docs/writing-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,12 @@ description: This guide explains how to write documentation for JSR packages.

Writing documentation is vital for the success of a package. JSR makes it very
easy for package authors to have great documentation, because it generates
documentation based on the JSDoc comments in the package source code.
documentation based on the JSDoc-like comments in the package source code.

The supported JSDoc-style features and tags are shared with Deno, and are listed
out on
[Deno's Supported JSDoc tags](https://docs.deno.com/runtime/reference/cli/doc/#supported-jsdoc-tags)
page.

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