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

Update docs pages #88

Merged
merged 5 commits into from
Jan 23, 2024
Merged

Update docs pages #88

merged 5 commits into from
Jan 23, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 22, 2024

@kalenmike @hassaanfarooq01

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

The ultralytics/hub-sdk GitHub PR introduces improvements to documentation and configuration settings.

πŸ“Š Key Changes

  • Removed double-quote-string-fixer config in .pre-commit-config.yaml for more flexible string formatting.
  • Enhanced documentation for dataset, model, project management, and overall SDK usage with descriptive content and structure.
  • Enriched Quickstart Guide with detailed setup instructions and contextual information.

🎯 Purpose & Impact

  • Improve developer experience by allowing both single and double-quoted strings in code.
  • Provide users with clear, comprehensive guidance on managing datasets, models, and projects using the Ultralytics HUB-SDK.
  • Help new users efficiently install and initialize the SDK, increasing accessibility and ease of use.
  • Simplified and contextual documentation encourages broader SDK adoption and smoother onboarding for users with different expertise levels.

docs/model.md Outdated Show resolved Hide resolved
docs/model.md Outdated Show resolved Hide resolved
docs/model.md Outdated Show resolved Hide resolved
@glenn-jocher
Copy link
Member Author

glenn-jocher commented Jan 23, 2024

@hassaanfarooq01 hey bud, just go ahead and directly take over and modify this PR, it's yours and @kalenmike's to do what you want with. Faster and simpler than suggesting changes.

EDIT: BTW all suggestions are good with me!

@glenn-jocher
Copy link
Member Author

glenn-jocher commented Jan 23, 2024

Once we get this cleaned up and merged then I can publish the HUB-SDK docs to https://docs.ultralytics.com/hub/sdk by merging ultralytics/ultralytics#7775

glenn-jocher and others added 4 commits January 23, 2024 18:39
Co-authored-by: Hassaan Farooq <103611273+hassaanfarooq01@users.noreply.github.com>
Co-authored-by: Hassaan Farooq <103611273+hassaanfarooq01@users.noreply.github.com>
Co-authored-by: Hassaan Farooq <103611273+hassaanfarooq01@users.noreply.github.com>
Co-authored-by: Hassaan Farooq <103611273+hassaanfarooq01@users.noreply.github.com>
@kalenmike kalenmike merged commit 3a2f894 into develop Jan 23, 2024
2 checks passed
@kalenmike kalenmike deleted the auto-docs branch January 23, 2024 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants