AOSSIE-Org / AOSSIE-Org/PictoPy

BUG:Broken image link in Manual Setup Guide (serverRunning.png returns 404)

Open
#1,358 4 comments 0 reactions 0 assignees View on GitHub
bug documentation
Dominant language
Python
Stars
283
Forks
679
Avg merge
7d 2h
Merged PRs (30d)
3

Description

### Is there an existing issue for this?

- [x] I have searched the existing issues

### What happened?

### Description
The screenshot showing the FastAPI dev server running is broken on the Manual Setup Guide page of the documentation site.

**Page:** https://aossie-org.github.io/PictoPy/Manual_Setup_Guide/

### Root Cause
The image file exists in the repo at `docs/assets/screenshots/serverRunning.png`, but the markdown source references it with this URL: https://aossie-org.github.io/docs/assets/screenshots/serverRunning.png
Since GitHub Pages publishes the `/docs` folder as the site root, the `docs/` segment should not appear in the published URL, and the repo name (`PictoPy`) needs to be the path prefix instead. The correct URL should be:

### Steps to Reproduce
1. Visit https://aossie-org.github.io/PictoPy/Manual_Setup_Guide/
2. Scroll to the "Python (FastAPI) Backend Setup Steps" section
3. The "server running" screenshot fails to load (404)

### Suggested Fix
Update the image URL in the source markdown file (likely `docs/Manual_Setup_Guide.md`) to either:
- The corrected absolute URL above, or
- A relative path (e.g. `../assets/screenshots/serverRunning.png`), which is more robust against future domain/path changes

### Additional Context
I'd like to work on this fix if it's confirmed — happy to open a PR.

### Record

- [x] I agree to follow this project's Code of Conduct

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.