Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
KunalSin9h committed Jul 17, 2024
1 parent 824de72 commit e900a04
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This is a guide for you to get started with contributing to Meltcd. Please read

Before we start, here are the important links you should know:

- [docs](https://cd.kunalsin9h.tech/docs)
- [docs](https://cd.kunalsin9h.com/docs)
- [to file an **issues**](https://github.com/kunalsin9h/meltcd/issues)
- [chat](https://discord.gg/Y2C6mEhhf3)

Expand Down Expand Up @@ -133,7 +133,7 @@ swag init --output ./docs/swagger
go run main.go server --verbose
```

The server will be running at post `1771` unless changed using environment variable, see the [docs](https://cd.kunalsin9h.tech/docs) for more information.
The server will be running at post `1771` unless changed using environment variable, see the [docs](https://cd.kunalsin9h.com/docs) for more information.

The api will be served at `http://localhost:1771/api`.

Expand Down Expand Up @@ -162,7 +162,7 @@ go run main.go server --verbose

So to work on frontend, after changing the code, you need to build the frontend and start the server.

**Deploying application**: Head over to [docs](https://cd.kunalsin9h.tech/docs/) to see how to deploy the application.
**Deploying application**: Head over to [docs](https://cd.kunalsin9h.com/docs/) to see how to deploy the application.

### CLI

Expand All @@ -174,7 +174,7 @@ You can run the CLI using
go run main.go app ls
```

For other CLI command see [docs](https://cd.kunalsin9h.tech/docs/).
For other CLI command see [docs](https://cd.kunalsin9h.com/docs/).

While the server is running, you can update the CLI code and test it.

Expand Down
2 changes: 1 addition & 1 deletion docs/swagger/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -933,7 +933,7 @@ const docTemplate = `{
},
"externalDocs": {
"description": "Meltcd Docs",
"url": "https://cd.kunalsin9h.tech/docs"
"url": "https://cd.kunalsin9h.com/docs"
}
}`

Expand Down
2 changes: 1 addition & 1 deletion docs/swagger/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -930,6 +930,6 @@
},
"externalDocs": {
"description": "Meltcd Docs",
"url": "https://cd.kunalsin9h.tech/docs"
"url": "https://cd.kunalsin9h.com/docs"
}
}
2 changes: 1 addition & 1 deletion docs/swagger/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ definitions:
type: object
externalDocs:
description: Meltcd Docs
url: https://cd.kunalsin9h.tech/docs
url: https://cd.kunalsin9h.com/docs
host: localhost:1771
info:
contact: {}
Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import (
// @license.name Apache 2.0
// @license.url https://github.com/kunalsin9h/meltcd/blob/main/LICENSE
// @externalDocs.description Meltcd Docs
// @externalDocs.url https://cd.kunalsin9h.tech/docs
// @externalDocs.url https://cd.kunalsin9h.com/docs
// @securityDefinitions.basic BasicAuth
// @securityDefinitions.apikey ApiKeyAuth
// @in header
Expand Down
2 changes: 1 addition & 1 deletion server/static/assets/index-5a047535.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ui/src/components/Layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ export default function Layout() {
${openHelpPanel ? "" : "hidden"}
`}
>
<Linker name="Documentation" url="https://cd.kunalsin9h.tech/docs" />
<Linker name="Documentation" url="https://cd.kunalsin9h.com/docs" />
<Linker
name="File bug or issue"
url="https://github.com/kunalsin9h/meltcd/issues"
Expand Down

0 comments on commit e900a04

Please sign in to comment.