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.

Sign up for GitHub

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

fix(docs): Fixed documentation inconsistencies: command formatting, syntax highlighting, and outdated references #1016

Merged
merged 5 commits into from
Mar 12, 2025
Merged

fix(docs): Fixed documentation inconsistencies: command formatting, syntax highlighting, and outdated references #1016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
904c814
fix: corrected code block syntax in publishing-packages.md, therefore…
EGAMAGZ Mar 12, 2025
5023f4c
fix: removed #jsr-feedback channel because it is archived
EGAMAGZ Mar 12, 2025
3a4526f
fix: remove leading dollar signs from shell command examples in publi…
EGAMAGZ Mar 12, 2025
411af6a
fix: Replaced Deno Discord with JSR Discord
EGAMAGZ Mar 12, 2025
dc95df4
style: Formatted code
EGAMAGZ Mar 12, 2025
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
4 changes: 2 additions & 2 deletions frontend/docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,8 @@ us at [email protected].

## How do I report a bug in JSR?

> During the open beta, please email us at [email protected], or chat in the `#jsr`
> channel on the Deno Discord (https://discord.gg/deno).
> During the open beta, please email us at [email protected], or chat in the
> [JSR Discord](https://discord.gg/hMqvhAn9xG).

Please open an issue on the JSR GitHub repository at
[jsr-io/jsr](https://github.com/jsr-io/jsr).
Expand Down
10 changes: 5 additions & 5 deletions frontend/docs/publishing-packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,9 +260,9 @@ registry.

```shell
# deno
$ deno publish --dry-run
deno publish --dry-run
# npm
$ npx jsr publish --dry-run
npx jsr publish --dry-run
# yarn
yarn dlx jsr publish --dry-run
# pnpm
Expand All @@ -282,9 +282,9 @@ Enter the root directory of your package (containing the `jsr.json` /

```shell
# deno
$ deno publish
deno publish
# npm
$ npx jsr publish
npx jsr publish
# yarn
yarn dlx jsr publish
# pnpm
Expand Down Expand Up @@ -433,7 +433,7 @@ because you have `"exports"` pointing to it (or a subdirectory of it). In this
case, you can un-ignore the `dist/` directory by using a negation in the
`exclude` field in your `jsr.json` / `deno.json` file.

```jsonc
```json
// jsr.json
{
"name": "@luca/greet",
Expand Down
3 changes: 1 addition & 2 deletions frontend/docs/why.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,6 @@ resource-constrained environments.

Your feedback will be critical to the success of JSR. If you have any ideas or
feedback on how JSR could work better for your use case, please let us know on
[Discord](https://discord.gg/deno) in either the `#jsr` or `#jsr-feedback`
channels.
[Discord](https://discord.gg/hMqvhAn9xG).

Ready to try JSR yourself? [Get started now](/docs/introduction).
2 changes: 1 addition & 1 deletion frontend/docs/with/cloudflare-workers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Running `wrangler dev` to start the local development server will run your
Cloudflare Worker. You can then visit `http://localhost:8787` to see the result.

```shell
$ wrangler dev
wrangler dev
```

[Learn more about using packages.](/docs/using-packages)
2 changes: 1 addition & 1 deletion frontend/docs/with/deno.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,5 +91,5 @@ package. This command will display a list of all dependencies, including their
version constraints.

```shell
$ deno info jsr:@std/fs
deno info jsr:@std/fs
```
2 changes: 1 addition & 1 deletion frontend/docs/with/nextjs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ application at `http://localhost:3000/`. You can then visit
`http://localhost:3000/` to see it.

```shell
$ next dev
next dev
```

[Learn more about using packages.](/docs/using-packages)
2 changes: 1 addition & 1 deletion frontend/docs/with/node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ console.log(red("Hello, world!"));
Running this code will print a red "Hello, world!" text to your terminal.

```shell
$ node main.js
node main.js
```

[Learn more about using packages.](/docs/using-packages)
2 changes: 1 addition & 1 deletion frontend/docs/with/vite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ at `http://localhost:5173`. You can then visit `http://localhost:5173` to see
it.

```shell
$ vite
vite
```

[Learn more about using packages.](/docs/using-packages)