Skip to content

Fix/readme docs#3056

Open
Sjorza wants to merge 11 commits intohotosm:devfrom
Sjorza:fix/readme-docs
Open

Fix/readme docs#3056
Sjorza wants to merge 11 commits intohotosm:devfrom
Sjorza:fix/readme-docs

Conversation

@Sjorza
Copy link
Copy Markdown
Contributor

@Sjorza Sjorza commented Apr 2, 2026

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation
  • 🧑‍💻 Refactor
  • ✅ Test
  • 🤖 Build or CI
  • ❓ Other (please specify)

Describe this PR

This PR improves the README by fixing broken links and hiding legacy assets that are currently returning 404 errors. Specifically:

  • Updated the overview link to point to the correct, working URL.

  • Commented out the splash image and the coverage badge to prevent broken icons on the main page. Once the source files or documentation pages are back online, they can be easily restored.

AI Tool Usage

  • No AI tools were used
  • AI tools were used (complete below)

Alternative Approaches Considered

No

Review Guide

Notes for the reviewer. How to test this change?

Checklist

  • I have read the Contributing Guide
  • I have read the Code of Conduct
  • PR is focused and small
  • Tests are included or updated
  • I understand all code in this PR and can answer questions about it
  • No secrets, credentials, or sensitive data are included
  • Commit messages are descriptive
  • Related docs and screenshots are updated

[optional] What gif best describes this PR or how it makes you feel?

@github-actions github-actions bot added bug Something isn't working docs Improvements or additions to documentation labels Apr 2, 2026
Copy link
Copy Markdown
Member

@spwoodcock spwoodcock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for picking these up! 🙏

Would love if a new screenshot could be added & the coverage badge fixed, but this could be a temp solution (we would need to make follow up issues to ensure it gets done though)

@Sjorza
Copy link
Copy Markdown
Contributor Author

Sjorza commented Apr 2, 2026

Happy to help! I'll look into fixing the coverage badge and providing a fresh screenshot.

To make sure it's exactly what you need: what specific part would you like a screenshot of?

I'll update the PR as soon as I have the right image and find the new home for the coverage data.

@spwoodcock
Copy link
Copy Markdown
Member

spwoodcock commented Apr 2, 2026

I know why the coverage is broken actually.

We used to publish the docs via a github workflow (from hotosm/gh-workflows) with the coverage: true var set. Now we just the Justfile.

We need to copy across the coverage generation logic as part of the Justfile, so we get coverage.html on the docs site, plus the coverage badge built again.


As for the screenshot, it could be good to have 3 mobile screenshots combined, to make up the full readme width:

  • One of the project creation screen in mobile layout, on the task splitting page (after running the straight skeleton algorithm on a good example - demonstrating the task splitting).
  • One of ODK Collect, the task selection question on the map.
  • One of a QField project showing the tasks and features, with labels etc.

I know this is a bit of hassle, but I really feel it would help to better demonstrate the app capabilities 😄

@Sjorza
Copy link
Copy Markdown
Contributor Author

Sjorza commented Apr 3, 2026

Fixed the backend coverage logic in tasks/docs. Working on the screenshots now. I will add them to this PR as soon as they are ready!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants