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

[Documentation]: Refactor Configuration Tutorial #1906

Open
3 tasks done
mavaylon1 opened this issue May 22, 2024 · 2 comments
Open
3 tasks done

[Documentation]: Refactor Configuration Tutorial #1906

mavaylon1 opened this issue May 22, 2024 · 2 comments
Assignees
Labels
category: enhancement improvements of code or code behavior priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs issues related to documentation
Milestone

Comments

@mavaylon1
Copy link
Collaborator

What would you like changed or added to the documentation and why?

Refactor the configuration tutorial to be more user approachable in terms of language.

Do you have any interest in helping write or edit the documentation?

Yes.

Code of Conduct

@mavaylon1 mavaylon1 added category: enhancement improvements of code or code behavior topic: docs issues related to documentation priority: low alternative solution already working and/or relevant to only specific user(s) labels May 22, 2024
@mavaylon1 mavaylon1 added this to the Future milestone May 22, 2024
@mavaylon1 mavaylon1 self-assigned this May 22, 2024
@rly
Copy link
Contributor

rly commented May 22, 2024

Ref: #1829 (comment)

@rly
Copy link
Contributor

rly commented May 22, 2024

I think we should also explain to the user in the documentation that the config file in https://github.com/NeurodataWithoutBorders/pynwb/tree/dev/src/pynwb/config/nwb_config.yaml is maintained by us and recommended for use and how to use it. We can also tell people to copy it into a new file and modify it for their own use if they want to customize the config file.

Understanding this now, I think that this config should be the default setting, but if so, we need to curate the species term set to be all the common species used in neurophysiology experiments.

Ref: https://github.com/NeurodataWithoutBorders/pynwb/pull/1829/files#r1610743030

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: enhancement improvements of code or code behavior priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs issues related to documentation
Projects
None yet
Development

No branches or pull requests

2 participants