Skip to content

Commit

Permalink
fixed some broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
kristiankyvik committed Mar 11, 2024
1 parent c83b6bc commit 5aac3ec
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ GPT-engineer is a community project and lives from your contributions - they are
- Discussion: raise awareness of a potential improvement. This is often a good starting point before making a detailed feature request.
- Pull request: implement code and have it reviewed and potentially merged by the maintainers. Implementations of existing feature requests or fixes to bug reports are likely to be merged.

By participating in this project, you agree to abide by the [code of conduct](CODE_OF_CONDUCT.md).
By participating in this project, you agree to abide by the [code of conduct](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/.github/CODE_OF_CONDUCT.md).

## Merge Policy for Pull Requests
Code that is likely to introduce breaking changes, or significantly change the user experience for users and developers, require [board approval](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/GOVERNANCE.md) to be merged. Smaller code changes can be merged directly.
Expand Down Expand Up @@ -115,6 +115,6 @@ At the beginning this might seem like a tedious process (having to add the file

## Licensing

By contributing to GPT Engineer, you agree that your contributions will be licensed under the [LICENSE](../LICENSE) file of the project.
By contributing to GPT Engineer, you agree that your contributions will be licensed under the [LICENSE](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/LICENSE) file of the project.

Thank you for your interest in contributing to GPT Engineer! We appreciate your support and look forward to your contributions.
2 changes: 1 addition & 1 deletion WINDOWS_README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Windows Setup
## Short version

On Windows, follow the standard [README.md](./README.md), but to set API key do one of:
On Windows, follow the standard [README.md](https://github.com/gpt-engineer-org/gpt-engineer/blob/main/README.md), but to set API key do one of:
- `set OPENAI_API_KEY=[your api key]` on cmd
- `$env:OPENAI_API_KEY="[your api key]"` on powershell

Expand Down
6 changes: 3 additions & 3 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
<br>

## Get started
[Here’s](/installation.html) how to install ``gpt-engineer``, set up your environment, and start building.
[Here’s]({doc}`/installation.html`) how to install ``gpt-engineer``, set up your environment, and start building.

We recommend following our [Quickstart](/quickstart.html) guide to familiarize yourself with the framework by building your first application with ``gpt-engineer``.
We recommend following our [Quickstart]({doc}`/quickstart.html`) guide to familiarize yourself with the framework by building your first application with ``gpt-engineer``.

<br>

## Example
You can find an example of the project in action [here](https://github.com/gpt-engineer-org/gpt-engineer/assets/4467025/6e362e45-4a94-4b0d-973d-393a31d92d9b).
You can find an example of the project in action here.

<video width="100%" controls>
<source src="https://github.com/gpt-engineer-org/gpt-engineer/assets/4467025/6e362e45-4a94-4b0d-973d-393a31d92d9b
Expand Down

0 comments on commit 5aac3ec

Please sign in to comment.