mirror of
https://github.com/Sea-Haven-Industries/open-swe.git
synced 2026-10-07 11:39:05 +00:00
fix: Update incorrect relative links in docs by adding /labs/swe prefix (#584)
* Apply patch * Apply patch * Apply patch * Apply patch * Apply patch * Apply patch * Apply patch * Apply patch * Apply patch * Apply patch * Apply patch * Apply patch * Apply patch * Apply patch * cr --------- Co-authored-by: open-swe[bot] <open-swe@users.noreply.github.com> Co-authored-by: bracesproul <braceasproul@gmail.com>
This commit is contained in:
parent
5823ff8fac
commit
27c9e0096f
6 changed files with 25 additions and 20 deletions
|
|
@ -21,13 +21,10 @@ Open SWE operates through three specialized LangGraph agents:
|
||||||
The agent can be used through a web interface or triggered automatically via GitHub webhooks, making it flexible for both interactive development and automated workflows.
|
The agent can be used through a web interface or triggered automatically via GitHub webhooks, making it flexible for both interactive development and automated workflows.
|
||||||
|
|
||||||
<CardGroup cols={2}>
|
<CardGroup cols={2}>
|
||||||
<Card title="Concepts" icon="bolt" href="/concepts">
|
<Card title="Setup" icon="robot" href="/labs/swe/setup/intro">
|
||||||
Concepts
|
|
||||||
</Card>
|
|
||||||
<Card title="Setup" icon="robot" href="/setup/intro">
|
|
||||||
How to set up Open SWE for development
|
How to set up Open SWE for development
|
||||||
</Card>
|
</Card>
|
||||||
<Card title="Usage" icon="database" href="/usage/intro">
|
<Card title="Usage" icon="database" href="/labs/swe/usage/intro">
|
||||||
Open SWE features, and how to use them
|
Open SWE features, and how to use them
|
||||||
</Card>
|
</Card>
|
||||||
</CardGroup>
|
</CardGroup>
|
||||||
|
|
@ -36,7 +33,6 @@ The agent can be used through a web interface or triggered automatically via Git
|
||||||
|
|
||||||
This documentation covers everything you need to know about Open SWE:
|
This documentation covers everything you need to know about Open SWE:
|
||||||
|
|
||||||
- **Concepts**: Core principles and architecture behind Open SWE
|
|
||||||
- **Usage**: How to interact with Open SWE through the web interface and GitHub webhooks
|
- **Usage**: How to interact with Open SWE through the web interface and GitHub webhooks
|
||||||
- **Setup**: Complete development environment setup including monorepo structure, dependencies, and authentication
|
- **Setup**: Complete development environment setup including monorepo structure, dependencies, and authentication
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -250,6 +250,6 @@ Once both servers are running:
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- Learn about [Authentication](/setup/authentication) to understand how the GitHub App integration works
|
- Learn about [Authentication](/labs/swe/setup/authentication) to understand how the GitHub App integration works
|
||||||
- Explore [Usage](/usage/intro) to start using Open SWE for code changes
|
- Explore [Usage](/labs/swe/usage/intro) to start using Open SWE for code changes
|
||||||
- Review the [Monorepo Structure](/setup/monorepo) for development best practices
|
- Review the [Monorepo Structure](/labs/swe/setup/monorepo) for development best practices
|
||||||
|
|
|
||||||
|
|
@ -12,11 +12,19 @@ Welcome to the Open SWE development setup guide. This section will walk you thro
|
||||||
The setup process is organized into focused sections to help you get up and running efficiently:
|
The setup process is organized into focused sections to help you get up and running efficiently:
|
||||||
|
|
||||||
<CardGroup cols={2}>
|
<CardGroup cols={2}>
|
||||||
<Card title="Development Setup" icon="code" href="/setup/development">
|
<Card
|
||||||
|
title="Development Setup"
|
||||||
|
icon="code"
|
||||||
|
href="/labs/swe/setup/development"
|
||||||
|
>
|
||||||
Complete guide to cloning the repository, installing dependencies,
|
Complete guide to cloning the repository, installing dependencies,
|
||||||
configuring environment variables, and starting the development servers.
|
configuring environment variables, and starting the development servers.
|
||||||
</Card>
|
</Card>
|
||||||
<Card title="Authentication" icon="shield-check" href="/setup/authentication">
|
<Card
|
||||||
|
title="Authentication"
|
||||||
|
icon="shield-check"
|
||||||
|
href="/labs/swe/setup/authentication"
|
||||||
|
>
|
||||||
Understanding the authentication flow, GitHub App configuration, and
|
Understanding the authentication flow, GitHub App configuration, and
|
||||||
security mechanisms used throughout Open SWE.
|
security mechanisms used throughout Open SWE.
|
||||||
</Card>
|
</Card>
|
||||||
|
|
|
||||||
|
|
@ -123,4 +123,4 @@ To start using Open SWE with webhooks:
|
||||||
4. **Monitor the issue comments** for the run link and status updates
|
4. **Monitor the issue comments** for the run link and status updates
|
||||||
5. **Review and merge the PR** when Open SWE completes the changes
|
5. **Review and merge the PR** when Open SWE completes the changes
|
||||||
|
|
||||||
For setup instructions, see the [Development Setup](/setup/development) guide.
|
For setup instructions, see the [Development Setup](/labs/swe/setup/development) guide.
|
||||||
|
|
|
||||||
|
|
@ -10,11 +10,11 @@ Open SWE provides two primary ways to interact with the coding agent, each desig
|
||||||
## Usage Methods
|
## Usage Methods
|
||||||
|
|
||||||
<CardGroup cols={2}>
|
<CardGroup cols={2}>
|
||||||
<Card title="Web Interface" icon="browser" href="/usage/ui">
|
<Card title="Web Interface" icon="browser" href="/labs/swe/usage/ui">
|
||||||
Interactive chat interface with manual and auto modes for direct agent
|
Interactive chat interface with manual and auto modes for direct agent
|
||||||
communication
|
communication
|
||||||
</Card>
|
</Card>
|
||||||
<Card title="GitHub Webhooks" icon="webhook" href="/usage/webhook">
|
<Card title="GitHub Webhooks" icon="webhook" href="/labs/swe/usage/webhook">
|
||||||
Automated triggers through GitHub issue labels for seamless repository
|
Automated triggers through GitHub issue labels for seamless repository
|
||||||
integration
|
integration
|
||||||
</Card>
|
</Card>
|
||||||
|
|
@ -29,7 +29,7 @@ You can explore Open SWE's capabilities using our hosted demo at [swe.langchain.
|
||||||
<Note>
|
<Note>
|
||||||
The demo application requires you to provide your own LLM API keys. For
|
The demo application requires you to provide your own LLM API keys. For
|
||||||
production use or development, we recommend setting up your own instance
|
production use or development, we recommend setting up your own instance
|
||||||
following our [development setup guide](/setup/development).
|
following our [development setup guide](/labs/swe/setup/development).
|
||||||
</Note>
|
</Note>
|
||||||
|
|
||||||
### Choose Your Workflow
|
### Choose Your Workflow
|
||||||
|
|
@ -40,9 +40,10 @@ You can explore Open SWE's capabilities using our hosted demo at [swe.langchain.
|
||||||
## What's Next?
|
## What's Next?
|
||||||
|
|
||||||
<Tip>
|
<Tip>
|
||||||
Start with the [Web Interface guide](/usage/ui) to understand Open SWE's core
|
Start with the [Web Interface guide](/labs/swe/usage/ui) to understand Open
|
||||||
capabilities, then explore [GitHub Webhooks](/usage/webhook) for automated
|
SWE's core capabilities, then explore [GitHub
|
||||||
integration into your development workflow.
|
Webhooks](/labs/swe/usage/webhook) for automated integration into your
|
||||||
|
development workflow.
|
||||||
</Tip>
|
</Tip>
|
||||||
|
|
||||||
Both usage methods leverage the same underlying LangGraph agent architecture with specialized graphs for planning, programming, and management, ensuring consistent behavior regardless of how you interact with Open SWE.
|
Both usage methods leverage the same underlying LangGraph agent architecture with specialized graphs for planning, programming, and management, ensuring consistent behavior regardless of how you interact with Open SWE.
|
||||||
|
|
|
||||||
|
|
@ -195,6 +195,6 @@ To begin using the Open SWE UI:
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
Make sure you have properly configured your GitHub App and authentication
|
Make sure you have properly configured your GitHub App and authentication
|
||||||
before using the UI. See the [Development Setup](/setup/development) guide for
|
before using the UI. See the [Development Setup](/labs/swe/setup/development)
|
||||||
details.
|
guide for details.
|
||||||
</Note>
|
</Note>
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue