Skip to content

Improve beginner onboarding and add known issue documentation#126

Open
shreyadesai20042009 wants to merge 1 commit into52North:mainfrom
shreyadesai20042009:docs-getting-started
Open

Improve beginner onboarding and add known issue documentation#126
shreyadesai20042009 wants to merge 1 commit into52North:mainfrom
shreyadesai20042009:docs-getting-started

Conversation

@shreyadesai20042009
Copy link

This PR improves beginner onboarding by enhancing documentation clarity and adding guidance for common issues.

Changes

  • Added beginner-friendly explanations around installation and next steps
  • Documented a known limitation when using the speedy_isobased algorithm with the provided test datasets
  • Included troubleshooting suggestions and referenced the related issue

Related issues

@kdemmich
Copy link
Collaborator

kdemmich commented Feb 2, 2026

Hi @shreyadesai20042009, thank you for your PR. We appreciate the time and effort that was put into it but, unfortunately, the description does not follow our PR template. We will not evaluate PRs that do not follow our PR template.

@kdemmich kdemmich added the question Further information is requested label Feb 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

question Further information is requested

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve installation and quick start documentation for beginner onboarding.

2 participants