Skip to content

update links in docs #184

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

Merged
mmabrouk merged 1 commit into from
Jul 31, 2023
Merged

update links in docs #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Hello, thank you for your interest in contributing to our project. We value your

## Getting Started

1. **Local Installation:** Before you start contributing, please install the project locally. You can find the necessary steps in our [Local Installation Guide](https://docs.agenta.ai/docs/installation/local-installation/local-installation).
1. **Local Installation:** Before you start contributing, please install the project locally. You can find the necessary steps in our [Local Installation Guide](https://docs.agenta.ai/installation/local-installation/local-installation).

2. **Understanding the Project:** Please take some time to read through our [Conceptual Guide](https://docs.agenta.ai/docs/conceptual/concepts) and [Architecture Guide](https://docs.agenta.ai/docs/conceptual/architecture) to understand the underlying principles and architecture of our project.
2. **Understanding the Project:** Please take some time to read through our [Conceptual Guide](https://docs.agenta.ai/conceptual/concepts) and [Architecture Guide](https://docs.agenta.ai/conceptual/architecture) to understand the underlying principles and architecture of our project.

3. **Start Development** Once you have a local installation and a good understanding of the project, you can start contributing. You can read the following tutorial to learn how to run the code in development mode: [Development Mode Tutorial](https://docs.agenta.ai/docs/contributing/development-mode).
3. **Start Development** Once you have a local installation and a good understanding of the project, you can start contributing. You can read the following tutorial to learn how to run the code in development mode: [Development Mode Tutorial](https://docs.agenta.ai/contributing/development-mode).

## Contribution Steps

Expand Down
2 changes: 1 addition & 1 deletion agenta-cli/agenta/templates/simple_prompt/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ OPENAI_API_KEY=sk-xxxxxxx
You can find your keys here:
https://platform.openai.com/account/api-keys

Go back to the [Getting started tutorial](https://docs.agenta.ai/docs/getting-started) to continue
Go back to the [Getting started tutorial](https://docs.agenta.ai/getting-started) to continue
2 changes: 1 addition & 1 deletion agenta-web/src/components/Playground/Views/TestView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ const BoxComponent: React.FC<BoxComponentProps> = ({
setResults(
"The code has resulted in the following error: \n\n --------------------- \n" +
e +
"\n---------------------\n\nPlease update your code, and re-serve it using cli and try again.\n\nFor more information please read https://docs.agenta.ai/docs/howto/how-to-debug\n\nIf you believe this is a bug, please create a new issue here: https://github.com/Agenta-AI/agenta/issues/new?title=Issue%20in%20playground",
"\n---------------------\n\nPlease update your code, and re-serve it using cli and try again.\n\nFor more information please read https://docs.agenta.ai/howto/how-to-debug\n\nIf you believe this is a bug, please create a new issue here: https://github.com/Agenta-AI/agenta/issues/new?title=Issue%20in%20playground",
)
}
}
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ mkdir example_app; cd example_app
agenta init
```

Next, start a new project based on the `simple_prompt` [template](https://docs.agenta.ai/docs/conceptual/concepts#templates)
Next, start a new project based on the `simple_prompt` [template](https://docs.agenta.ai/conceptual/concepts#templates)

````
? Please enter the app name: company_name_generator
Expand Down
2 changes: 1 addition & 1 deletion examples/job_classifier/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ OPENAI_API_KEY=sk-xxxxxxx
You can find your keys here:
https://platform.openai.com/account/api-keys

Go back to the [Getting started tutorial](https://docs.agenta.ai/docs/getting-started) to continue
Go back to the [Getting started tutorial](https://docs.agenta.ai/getting-started) to continue
2 changes: 1 addition & 1 deletion examples/sales_transcript_summarizer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ OPENAI_API_KEY=sk-xxxxxxx

You can find your keys [here](https://platform.openai.com/account/api-keys)

Go back to the [Getting started tutorial](https://docs.agenta.ai/docs/getting-started) to continue
Go back to the [Getting started tutorial](https://docs.agenta.ai/getting-started) to continue

## Example Prompts

Expand Down