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

getting started documentation #114

Open
Tracked by #145
sbillinge opened this issue Oct 23, 2024 · 4 comments
Open
Tracked by #145

getting started documentation #114

sbillinge opened this issue Oct 23, 2024 · 4 comments
Milestone

Comments

@sbillinge
Copy link
Contributor

Problem

no human written docs as yet

Proposed solution

Write the docs including a step by step getting started

@yucongalicechen
Copy link
Collaborator

Per discussion in #113: add examples/instructions for entering username and email in the config file.

@sbillinge sbillinge added this to the 0.2.1 release milestone Oct 26, 2024
@yucongalicechen
Copy link
Collaborator

From #153 and #151: explain in docs about what's going on in WAVELENGTH

@sbillinge
Copy link
Contributor Author

@yucongalicechen where it makes sense we can reuse text from the paper. For sure, cite the paper in the package, but we can also reuse parts of the text where it makes sense.

@yucongalicechen
Copy link
Collaborator

yucongalicechen commented Jan 27, 2025

(Just to keep notes about what to add in the docs besides the explanation for functions and use cases)

Write Utilities and Examples for:

Sorry, something went wrong.

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

No branches or pull requests

2 participants