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

Fix documentation links #657

Merged
merged 2 commits into from
Nov 12, 2024
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
blank_issues_enabled: false
contact_links:
- name: Discussion
url: https://github.com/nats-io/nats.net.v2/discussions
url: https://github.com/nats-io/nats.net/discussions
about: Ideal for ideas, feedback, or longer form questions.
- name: Chat
url: https://slack.nats.io
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

Thanks for your interest in contributing! This document contains `nats-io/nats.net.v2` specific contributing details. If you are a first-time contributor, please refer to the general [NATS Contributor Guide](https://nats.io/contributing/) to get a comprehensive overview of contributing to the NATS project.
Thanks for your interest in contributing! This document contains `nats-io/nats.net` specific contributing details. If you are a first-time contributor, please refer to the general [NATS Contributor Guide](https://nats.io/contributing/) to get a comprehensive overview of contributing to the NATS project.

## Getting started

Expand All @@ -10,7 +10,7 @@ There are three general ways you can contribute to this repo:
- Reporting a bug or regression
- Contributing changes to the source code

For the first two, refer to the [GitHub Issues](https://github.com/nats-io/nats.net.v2/issues/new/choose) which guides you through the available options along with the needed information to collect.
For the first two, refer to the [GitHub Issues](https://github.com/nats-io/nats.net/issues/new/choose) which guides you through the available options along with the needed information to collect.

## Contributing Changes

Expand All @@ -34,4 +34,4 @@ A good pull request includes:

## Get Help

If you have questions about the contribution process, please start a [GitHub discussion](https://github.com/nats-io/nats.net.v2/discussions) or join the [NATS Slack](https://slack.nats.io/).
If you have questions about the contribution process, please start a [GitHub discussion](https://github.com/nats-io/nats.net/discussions) or join the [NATS Slack](https://slack.nats.io/).
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ Head over to [NATS documentation](https://docs.nats.io/nats-concepts/overview) f

## Quick Start

Install the [NATS.Net](https://www.nuget.org/packages/NATS.Net) package from NuGet:

```bash
dotnet add package NATS.Net
```

Basic messaging:

```csharp
Expand All @@ -48,9 +54,10 @@ await foreach (var msg in nc.SubscribeAsync<string>(subject: "foo"))
await nc.PublishAsync(subject: "foo", data: "Hello, World!");
```

Persistance with JetStream:
Persistence with JetStream:

```csharp
// NATS JetStream basic publish-consume example
await using var nc = new NatsClient();
var js = nc.CreateJetStreamContext();

Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/advanced/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All you need to do is to pass your credentials to the connection.

[!code-csharp[](../../../tests/NATS.Net.DocsExamples/Advanced/SecurityPage.cs#user-pass)]

See also [user authentication tests](https://github.com/nats-io/nats.net.v2/blob/main/tests/NATS.Client.Core.Tests/NatsConnectionTest.Auth.cs) for more examples.
See also [user authentication tests](https://github.com/nats-io/nats.net/blob/main/tests/NATS.Client.Core.Tests/NatsConnectionTest.Auth.cs) for more examples.

## Implicit TLS Connections

Expand Down
4 changes: 2 additions & 2 deletions docs/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
homepage: api/index.md

- name: GitHub
href: https://github.com/nats-io/nats.net.v2
href: https://github.com/nats-io/nats.net

- name: Slack
href: https://natsio.slack.com/channels/dotnet
href: https://slack.nats.io