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

Create Development Environment Setup Guide #34

Open
devin-ai-integration bot opened this issue Feb 15, 2025 · 5 comments
Open

Create Development Environment Setup Guide #34

devin-ai-integration bot opened this issue Feb 15, 2025 · 5 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@devin-ai-integration
Copy link
Contributor

Add detailed development setup documentation including:

  • Required Python versions and dependencies
  • nbdev workflow explanation
  • Common development tasks
  • Troubleshooting guide

Example additions:

## Development Setup
1. Install dependencies:
```bash
pip install -e '.[dev]'
nbdev_install_quarto
  1. Setup pre-commit hooks:
nbdev_install_hooks

Estimated time: 2-4 hours
@devin-ai-integration devin-ai-integration bot added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 15, 2025
@ncoop57 ncoop57 added the help wanted Extra attention is needed label Feb 15, 2025
@aditya0yadav
Copy link
Contributor

I can work on this

@aditya0yadav
Copy link
Contributor

will this documentation be available on the web using nbdev or making docs on rst file

@ncoop57
Copy link
Contributor

ncoop57 commented Feb 18, 2025

@aditya0yadav awesome! It'll be available via nbdev. We have a url for it set to https://ssage.answer.ai/ 🤓

@aditya0yadav
Copy link
Contributor

Required Python versions and dependencies is 3.9 or above

or am i wrong

@ncoop57
Copy link
Contributor

ncoop57 commented Feb 22, 2025

Yes, that's correct @aditya0yadav

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants