Skip to content

Commit e863ffe

Browse files
marcuskohlbergmarcuskohlberg
authored
update docs links (#180)
1 parent 30b70ee commit e863ffe

File tree

102 files changed

+272
-232
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+272
-232
lines changed

Diff for: ‎ai-chat/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This application is your bridge between popular chat platforms like Discord and
1515

1616
### Prerequisites
1717

18-
* **Encore:** You'll need Encore to get started. Follow the installation instructions at [https://encore.dev/docs/install](https://encore.dev/docs/install).
18+
* **Encore:** You'll need Encore to get started. Follow the installation instructions at [https://encore.dev/docs/install](https://encore.dev/docs/go/install).
1919
* **OpenAI API Key:** To use OpenAI's models, grab an API key from [https://platform.openai.com/api-keys](https://platform.openai.com/api-keys).
2020

2121
### Run Locally

Diff for: ‎ai-chat/chat/provider/discord/service.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ import (
2727
"encore.dev/storage/sqldb"
2828
)
2929

30-
// This uses Encore's declarative database , learn more: https://encore.dev/docs/primitives/databases
30+
// This uses Encore's declarative database , learn more: https://encore.dev/docs/go/primitives/databases
3131
var discorddb = sqldb.NewDatabase("discord", sqldb.DatabaseConfig{
3232
Migrations: "./db/migrations",
3333
})
3434

35-
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/primitives/secrets
35+
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/go/primitives/secrets
3636
var secrets struct {
3737
DiscordToken string
3838
}
3939

40-
// This declares a Encore Service, learn more: https://encore.dev/docs/primitives/services-and-apis/service-structs
40+
// This declares a Encore Service, learn more: https://encore.dev/docs/go/primitives/service-structs
4141
//
4242
//encore:service
4343
type Service struct {

Diff for: ‎ai-chat/chat/provider/pubsub.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66

77
// InboxTopic is the pubsub topic for messages from chat providers
88
//
9-
// This uses Encore's pubsub package, learn more: https://encore.dev/docs/primitives/pubsub
9+
// This uses Encore's pubsub package, learn more: https://encore.dev/docs/go/primitives/pubsub
1010
var InboxTopic = pubsub.NewTopic[*Message]("inbox", pubsub.TopicConfig{
1111
DeliveryGuarantee: pubsub.AtLeastOnce,
1212
})

Diff for: ‎ai-chat/chat/provider/slack/service.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ const (
2626
BotMessageEventType = "bot_message"
2727
)
2828

29-
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/primitives/secrets
29+
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/go/primitives/secrets
3030
var secrets struct {
3131
SlackToken string
3232
}
3333

34-
// This declares a Encore Service, learn more: https://encore.dev/docs/primitives/services-and-apis/service-structs
34+
// This declares a Encore Service, learn more: https://encore.dev/docs/go/primitives/service-structs
3535
//
3636
//encore:service
3737
type Service struct {

Diff for: ‎ai-chat/llm/provider/gemini/gemini.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ type Config struct {
2626
TopK config.Int32
2727
}
2828

29-
// This uses Encore Configuration, learn more: https://encore.dev/docs/develop/config
29+
// This uses Encore Configuration, learn more: https://encore.dev/docs/go/develop/config
3030
var cfg = config.Load[*Config]()
3131

32-
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/primitives/secrets
32+
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/go/primitives/secrets
3333
var secrets struct {
3434
GeminiJSONCredentials string
3535
}
3636

37-
// This declares a Encore Service, learn more: https://encore.dev/docs/primitives/services-and-apis/service-structs
37+
// This declares a Encore Service, learn more: https://encore.dev/docs/go/primitives/service-structs
3838
//
3939
//encore:service
4040
type Service struct {

Diff for: ‎ai-chat/llm/provider/openai/openai.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import (
2020

2121
var TopicRef = pubsub.TopicRef[pubsub.Publisher[*provider.BotResponse]](provider.LLMMessageTopic)
2222

23-
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/primitives/secrets
23+
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/go/primitives/secrets
2424
var secrets struct {
2525
OpenAIKey string
2626
}
@@ -33,10 +33,10 @@ type Config struct {
3333
TopP config.Float32
3434
}
3535

36-
// This uses Encore Configuration, learn more: https://encore.dev/docs/develop/config
36+
// This uses Encore Configuration, learn more: https://encore.dev/docs/go/develop/config
3737
var cfg = config.Load[*Config]()
3838

39-
// This declares a Encore Service, learn more: https://encore.dev/docs/primitives/services-and-apis/service-structs
39+
// This declares a Encore Service, learn more: https://encore.dev/docs/go/primitives/service-structs
4040
//
4141
//encore:service
4242
type Service struct {

Diff for: ‎ai-chat/llm/provider/provider.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ func (req *ChatRequest) UsersByID() map[uuid.UUID]*chatdb.User {
129129

130130
// LLMMessageTopic is a topic for messages generated by the LLM providers.
131131
//
132-
// This uses Encore's pubsub package, learn more: https://encore.dev/docs/primitives/pubsub
132+
// This uses Encore's pubsub package, learn more: https://encore.dev/docs/go/primitives/pubsub
133133
var LLMMessageTopic = pubsub.NewTopic[*BotResponse]("llm-messages", pubsub.TopicConfig{
134134
DeliveryGuarantee: pubsub.AtLeastOnce,
135135
})

Diff for: ‎ai-chat/llm/service/pubsub.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ import (
1212
// TaskTopic is a topic for tasks generated by the chat service.
1313
// We use a topic to allow for asynchronous processing of tasks (the LLMs can be slow).
1414
//
15-
// This uses Encore's pubsub package, learn more: https://encore.dev/docs/primitives/pubsub
15+
// This uses Encore's pubsub package, learn more: https://encore.dev/docs/go/primitives/pubsub
1616
var TaskTopic = pubsub.NewTopic[*provider.ChatRequest]("llm-task", pubsub.TopicConfig{
1717
DeliveryGuarantee: pubsub.AtLeastOnce,
1818
})
1919

2020
// chat-sub is a subscription to the chat task topic. It handles all incoming tasks from the chat service.
2121
//
22-
// This uses Encore's pubsub package, learn more: https://encore.dev/docs/primitives/pubsub
22+
// This uses Encore's pubsub package, learn more: https://encore.dev/docs/go/primitives/pubsub
2323
var _ = pubsub.NewSubscription(
2424
TaskTopic, "chat-sub",
2525
pubsub.SubscriptionConfig[*provider.ChatRequest]{

Diff for: ‎ai-chat/llm/service/service.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ func (c channelTasks) get(channelID uuid.UUID, provider string) (string, bool) {
4949
return taskID, ok
5050
}
5151

52-
// This declares a Encore Service, learn more: https://encore.dev/docs/primitives/services-and-apis/service-structs
52+
// This declares a Encore Service, learn more: https://encore.dev/docs/go/primitives/service-structs
5353
//
5454
//encore:service
5555
type Service struct {

Diff for: ‎ai-chat/proxy/proxy.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
"encore.dev/rlog"
1414
)
1515

16-
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/primitives/secrets
16+
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/go/primitives/secrets
1717
var secrets struct {
1818
NGrokToken string
1919
NGrokDomain string

Diff for: ‎assemblyai-starter/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This is an Encore starter for a Conversational Intelligence app that uses [Assem
44

55
## Developing locally
66

7-
When you have [installed Encore](https://encore.dev/docs/install), you can create a new Encore application and clone this example with this command.
7+
When you have [installed Encore](https://encore.dev/docs/go/install), you can create a new Encore application and clone this example with this command.
88

99
```bash
1010
encore app create my-app-name --example=assemblyai-starter
@@ -42,7 +42,7 @@ While `encore run` is running, open <http://localhost:4000/frontend> to view the
4242

4343
## Open the developer dashboard
4444

45-
While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to access Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
45+
While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to access Encore's [local developer dashboard](https://encore.dev/docs/go/observability/dev-dash).
4646

4747
Here you can see API docs, make requests in the API explorer, and view traces of the responses.
4848

Diff for: ‎auth0-react-sdk/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You an also take a look at [auth0](https://github.com/encoredev/examples/blob/ma
77

88
## Cloning the example
99

10-
When you have [installed Encore](https://encore.dev/docs/install), you can create a new Encore application and clone
10+
When you have [installed Encore](https://encore.dev/docs/go/install), you can create a new Encore application and clone
1111
this example by running this command:
1212

1313
```bash
@@ -122,4 +122,4 @@ global_cors: {
122122
}
123123
```
124124

125-
More information on CORS configuration can be found here: https://encore.dev/docs/develop/cors
125+
More information on CORS configuration can be found here: https://encore.dev/docs/go/develop/cors

Diff for: ‎auth0-react-sdk/backend/admin/admin.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package admin
22

33
import (
44
"context"
5+
56
a "encore.app/backend/auth"
67
"encore.dev/beta/auth"
78
"encore.dev/rlog"
@@ -12,7 +13,7 @@ type DashboardData struct {
1213
}
1314

1415
// Endpoints annotated with `auth` are public and requires authentication
15-
// Learn more: encore.dev/docs/primitives/services-and-apis#access-controls
16+
// Learn more: encore.dev/docs/go/primitives/defining-apis#access-controls
1617
//
1718
//encore:api auth method=GET path=/admin
1819
func GetAdminDashboardData(ctx context.Context) (*DashboardData, error) {

Diff for: ‎auth0-react-sdk/backend/auth/auth.go

+5-4
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@ package auth
33
import (
44
"context"
55
"encoding/json"
6+
"net/http"
7+
"net/url"
8+
69
"encore.dev/beta/auth"
710
"encore.dev/beta/errs"
811
"encore.dev/config"
912
"github.com/auth0/go-jwt-middleware/v2/jwks"
1013
"github.com/auth0/go-jwt-middleware/v2/validator"
11-
"net/http"
12-
"net/url"
1314
)
1415

1516
type Auth0Config struct {
@@ -20,7 +21,7 @@ type Auth0Config struct {
2021
var cfg = config.Load[*Auth0Config]()
2122

2223
// Service struct definition.
23-
// Learn more: encore.dev/docs/primitives/services-and-apis/service-structs
24+
// Learn more: encore.dev/docs/go/primitives/service-structs
2425
//
2526
//encore:service
2627
type Service struct {
@@ -57,7 +58,7 @@ type UserData struct {
5758

5859
// The `encore:authhandler` annotation tells Encore to run this function for all
5960
// incoming API call that requires authentication.
60-
// Learn more: encore.dev/docs/develop/auth#the-auth-handler
61+
// Learn more: encore.dev/docs/go/develop/auth#the-auth-handler
6162
//
6263
//encore:authhandler
6364
func (s *Service) AuthHandler(ctx context.Context, token string) (auth.UID, *UserData, error) {

Diff for: ‎auth0/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Auth0 + React + Encore App Example
22

33
This is an example of how to do user authentication using [Auth0](https://auth0.com/) in an Encore app.
4-
Check out the [Use Auth0 with your app](https://encore.dev/docs/how-to/auth0-auth) guide to learn more about this example.
4+
Check out the [Use Auth0 with your app](https://encore.dev/docs/go/how-to/auth0-auth) guide to learn more about this example.
55

66
For this example the login/logout flow is done through Encore and the frontend is React + React Router.
77
Take a look at [auth0-react-sdk](https://github.com/encoredev/examples/blob/main/auth0-react-sdk) for an example where the login/logout flow is abstracted away by the Auth0 React SDK.
88

99
## Cloning the example
1010

11-
When you have [installed Encore](https://encore.dev/docs/install), you can create a new Encore application and clone
11+
When you have [installed Encore](https://encore.dev/docs/go/install), you can create a new Encore application and clone
1212
this example by running this command:
1313

1414
```bash
@@ -32,7 +32,7 @@ The same goes for the logout URL (were the user will get redirected after logout
3232

3333
In `backend/auth/auth-config.cue`, replace the values for the `ClientID` and `Domain` that you got from the Auth0 dashboard.
3434

35-
The `ClientSecret` is especially sensitive and should not be hardcoded in your code/config. Instead, you should store that as an [Encore secret](https://encore.dev/docs/primitives/secrets).
35+
The `ClientSecret` is especially sensitive and should not be hardcoded in your code/config. Instead, you should store that as an [Encore secret](https://encore.dev/docs/go/primitives/secrets).
3636

3737
From your terminal (inside your Encore app directory), run:
3838

@@ -133,4 +133,4 @@ global_cors: {
133133
}
134134
```
135135

136-
More information on CORS configuration can be found here: https://encore.dev/docs/develop/cors
136+
More information on CORS configuration can be found here: https://encore.dev/docs/go/develop/cors

Diff for: ‎auth0/backend/auth/auth.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
)
1111

1212
// Service struct definition.
13-
// Learn more: encore.dev/docs/primitives/services-and-apis/service-structs
13+
// Learn more: encore.dev/docs/go/primitives/service-structs
1414
//
1515
//encore:service
1616
type Service struct {
@@ -131,7 +131,7 @@ type ProfileData struct {
131131

132132
// The `encore:authhandler` annotation tells Encore to run this function for all
133133
// incoming API call that requires authentication.
134-
// Learn more: encore.dev/docs/develop/auth#the-auth-handler
134+
// Learn more: encore.dev/docs/go/develop/auth#the-auth-handler
135135
//
136136
//encore:authhandler
137137
func (s *Service) AuthHandler(
@@ -169,7 +169,7 @@ func (s *Service) AuthHandler(
169169
}
170170

171171
// Endpoints annotated with `auth` are public and requires authentication
172-
// Learn more: encore.dev/docs/primitives/services-and-apis#access-controls
172+
// Learn more: encore.dev/docs/go/primitives/defining-apis#access-controls
173173
//
174174
//encore:api auth method=GET path=/profile
175175
func GetProfile(ctx context.Context) (*ProfileData, error) {

Diff for: ‎bits/elevenlabs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,5 +59,5 @@ await audio.play();
5959
6060
## Learn More
6161

62-
- [Encore Documentation](https://encore.dev/docs)
62+
- [Encore Documentation](https://encore.dev/docs/go)
6363
- [ElevenLabs Documentation](https://docs.elevenlabs.io/welcome/introduction)

Diff for: ‎bits/pexels/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The `pexels` package contains the following endpoints:
3737

3838

3939
## Frontend example usage
40-
After generating a [request client](https://encore.dev/docs/develop/client-generation) for your frontend you can call
40+
After generating a [request client](https://encore.dev/docs/go/cli/client-generation) for your frontend you can call
4141
the endpoints like this:
4242

4343
```ts
@@ -62,5 +62,5 @@ console.log(resp.photos);
6262

6363
## Learn More
6464

65-
- [Encore Documentation](https://encore.dev/docs)
65+
- [Encore Documentation](https://encore.dev/docs/go)
6666
- [Pexels Documentation](https://www.pexels.com/api/documentation/)

Diff for: ‎bits/pexels/pexels.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
)
1111

1212
// Authorization is required for the Pexels API. All requests you make to the API will need to include your key.
13-
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/primitives/secrets
13+
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/go/primitives/secrets
1414
var secrets struct {
1515
PexelsApiKey string
1616
}

Diff for: ‎bits/sendgrid/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,6 @@ curl 'http://localhost:4000/sendgrid' \
5151

5252
## Learn More
5353

54-
- [Encore Documentation](https://encore.dev/docs)
55-
- [Pub/Sub Documentation](https://encore.dev/docs/primitives/pubsub)
54+
- [Encore Documentation](https://encore.dev/docs/go)
55+
- [Pub/Sub Documentation](https://encore.dev/docs/go/primitives/pubsub)
5656
- [SendGrid Documentation](https://docs.sendgrid.com/)

Diff for: ‎bits/sendgrid/sendgrid.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212
"github.com/sendgrid/sendgrid-go/helpers/mail"
1313
)
1414

15-
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/primitives/secrets
15+
// This uses Encore's built-in secrets manager, learn more: https://encore.dev/docs/go/primitives/secrets
1616
var secrets struct {
1717
SendGridAPIKey string
1818
}
@@ -65,7 +65,7 @@ type EmailPreparedEvent struct {
6565
HTMLContent string
6666
}
6767

68-
// This creates a Pub/Sub topic, learn more: https://encore.dev/docs/primitives/pubsub
68+
// This creates a Pub/Sub topic, learn more: https://encore.dev/docs/go/primitives/pubsub
6969
var Emails = pubsub.NewTopic[*EmailPreparedEvent]("emails", pubsub.TopicConfig{
7070
DeliveryGuarantee: pubsub.AtLeastOnce,
7171
})

Diff for: ‎booking-system/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ While `encore run` is running, head over to [http://localhost:4000/frontend/](ht
4040

4141
## Local Development Dashboard
4242

43-
While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to access Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
43+
While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to access Encore's [local developer dashboard](https://encore.dev/docs/go/observability/dev-dash).
4444

4545
Here you can see traces for all the request that were generated when you used your app from the frontend, view your architecture diagram, and see API docs in the Service Catalog.
4646

@@ -49,7 +49,7 @@ Here you can see traces for all the request that were generated when you used yo
4949

5050
### Self-hosting
5151

52-
See the [self-hosting instructions](https://encore.dev/docs/self-host/docker-build) for how to use `encore build docker` to create a Docker image and configure it.
52+
See the [self-hosting instructions](https://encore.dev/docs/go/self-host/docker-build) for how to use `encore build docker` to create a Docker image and configure it.
5353

5454
### Encore Cloud Platform
5555

@@ -73,4 +73,4 @@ Follow these steps to link your app to GitHub:
7373
4. To configure Encore to automatically trigger deploys when you push to a specific branch name, go to the **Overview** page for your intended environment. Click on **Settings** and then in the section **Branch Push** configure the **Branch name** and hit **Save**.
7474
5. Commit and push a change to GitHub to trigger a deploy.
7575

76-
[Learn more in the docs](https://encore.dev/docs/how-to/github)
76+
[Learn more in the docs](https://encore.dev/docs/platform/integrations/github)

Diff for: ‎booking-system/booking/booking.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ type ListBookingsResponse struct {
129129
}
130130

131131
// This defines a public endpoint that requires authentication
132-
// Learn more: https://encore.dev/docs/primitives/services-and-apis#access-controls
132+
// Learn more: https://encore.dev/docs/go/primitives/defining-apis#access-controls
133133
//
134134
//encore:api auth method=GET path=/booking
135135
func ListBookings(ctx context.Context) (*ListBookingsResponse, error) {

Diff for: ‎booking-system/frontend/frontend.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ var (
1616
)
1717

1818
// Serve serves the frontend for development using a raw endpoint.
19-
// Learn more: https://encore.dev/docs/primitives/services-and-apis#raw-endpoints
19+
// Learn more: https://encore.dev/docs/go/primitives/raw-endpoints
2020
// For production use we recommend deploying the frontend
2121
// using Vercel, Netlify, or similar.
2222
//

0 commit comments

Comments
 (0)