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

File paths for images in forge docs are out of date #7198

Open
1 task done
xfq opened this issue Jun 7, 2024 · 2 comments
Open
1 task done

File paths for images in forge docs are out of date #7198

xfq opened this issue Jun 7, 2024 · 2 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@xfq
Copy link

xfq commented Jun 7, 2024

⚠️ Search for existing issues first ⚠️

  • I have searched the existing issues, and there is no existing issue for my problem

Which Operating System are you using?

MacOS

Which version of AutoGPT are you using?

Latest Release

Do you use OpenAI GPT-3 or GPT-4?

GPT-3.5

Which area covers your issue best?

Documentation

Describe your issue.

  1. Go to https://github.com/Significant-Gravitas/AutoGPT?tab=readme-ov-file#-building-blocks
  2. Click Getting Started with Forge
  3. The images in the Markdown file are broken

Upload Activity Log Content

No response

Upload Error Log Content

No response

@ntindle ntindle changed the title Can't see the images File paths for images in forge docs are out of date Jun 9, 2024
@ntindle ntindle added the good first issue Good for newcomers label Jun 9, 2024
@ntindle
Copy link
Member

ntindle commented Jun 9, 2024

/boosterbot

Copy link

boosterbot-ai bot commented Jun 9, 2024

To resolve this issue, we need to: 1) Identify the correct paths for the images, 2) Update the Markdown file with the correct paths, 3) Ensure the build configuration correctly processes and copies the images to the appropriate directory. This will involve checking the docs/mkdocs.yml and docs/netlify.toml files to ensure they are correctly configured.

  • docs/overrides/main.html - This file customizes the appearance and behavior of the documentation site by including styles and scripts. Consider reviewing the custom styles and scripts in docs/overrides/main.html to ensure they are not interfering with the display of images.
  • docs/mkdocs.yml - This file configures the structure, appearance, and functionality of the AutoGPT documentation site. Consider verifying the docs_dir setting in docs/mkdocs.yml to ensure it correctly points to the directory containing the documentation files. Also, check the nav section to ensure the paths to the Markdown files are correct.
  • frontend/web/manifest.json - This file defines the configuration and appearance of the Flutter web application. Consider reviewing the manifest.json file to ensure it does not contain any misconfigurations that could indirectly affect the documentation site.
  • docs/netlify.toml - This file configures the build settings for deploying the AutoGPT documentation site on Netlify. Consider verifying the build command in docs/netlify.toml to ensure it correctly processes and copies the images to the public directory.

@ntindle ntindle added the help wanted Extra attention is needed label Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants