Skip to content
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.

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

fix(platform): Refresh doc setup instruction #8142

Merged

Conversation

majdyz
Copy link
Contributor

@majdyz majdyz commented Sep 23, 2024

Background

The development setup has changed a lot, and some of the instructions is no longer valid.

Changes 🏗️

  • Update setup instruction
  • Simplify the prerequisite by not forcing yarn.
  • Reduce explicit cds and reduce the amount.

Testing 🔍

Note

Only for the new autogpt platform, currently in autogpt_platform/

  • Create from scratch and execute an agent with at least 3 blocks
  • Import an agent from file upload, and confirm it executes correctly
  • Upload agent to marketplace
  • Import an agent from marketplace and confirm it executes correctly
  • Edit an agent from monitor, and confirm it executes correctly

@majdyz majdyz requested a review from aarushik93 September 23, 2024 21:24
@majdyz majdyz requested a review from a team as a code owner September 23, 2024 21:24
@majdyz majdyz requested review from ntindle and removed request for a team September 23, 2024 21:24
Copy link

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Key issues to review

Inconsistent Command
The README suggests using both npm and yarn for frontend setup, which may confuse users. It's better to stick to one package manager for consistency.

Missing Information
The setup instructions don't mention the need for an OpenAI API key, which is likely required for the AutoGPT platform to function properly.

@github-actions github-actions bot added documentation Improvements or additions to documentation size/l and removed Review effort [1-5]: 2 labels Sep 23, 2024
Copy link

netlify bot commented Sep 23, 2024

Deploy Preview for auto-gpt-docs ready!

Name Link
🔨 Latest commit 27452e0
🔍 Latest deploy log https://app.netlify.com/sites/auto-gpt-docs/deploys/66f33ffbfe23e7000800f220
😎 Deploy Preview https://deploy-preview-8142--auto-gpt-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@aarushik93
Copy link
Contributor

cc @Bentlybro

@Bentlybro
Copy link
Member

Bentlybro commented Sep 23, 2024

Thanks for the tag @aarushik93 ill go over this first thing in the morning!

@majdyz majdyz enabled auto-merge (squash) September 23, 2024 21:53
@ntindle
Copy link
Member

ntindle commented Sep 24, 2024

autogpt_platform/README.md Outdated Show resolved Hide resolved
docs/content/server/setup.md Show resolved Hide resolved
docs/content/server/setup.md Outdated Show resolved Hide resolved
@majdyz majdyz requested review from Swiftyos and ntindle September 24, 2024 15:33
@majdyz
Copy link
Contributor Author

majdyz commented Sep 24, 2024

Consider looking into this https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#grouping-code-blocks-c for yarn/npm

I removed entirely the occurrence of yarn on mkdocs documentation, the one remain is the readme.md on the repository.

@majdyz majdyz dismissed Swiftyos’s stale review September 24, 2024 21:33

Addressed, please re-review

@majdyz majdyz merged commit 6da8007 into master Sep 24, 2024
11 checks passed
@majdyz majdyz deleted the zamilmajdy/open-1860-resolve-autogpt-platform-setup-doc-problems branch September 24, 2024 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/l
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants