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 Readme #280

Merged
merged 11 commits into from
Feb 5, 2024
Merged

Update Readme #280

merged 11 commits into from
Feb 5, 2024

Conversation

pauladkisson
Copy link
Member

@pauladkisson pauladkisson commented Jan 31, 2024

Update Readme to conform to neuroconv's style

See #282 to see how info from the developer guide section is now included in the documentation

@CodyCBakerPhD
Copy link
Member

CodyCBakerPhD commented Feb 1, 2024

As discussed, while we're improving this README overall, let's

  • standardize appearance to be consistent with our other main packages; probably mimic NeuroConv's README as much as possible

  • would be nice to have a brand logo for this project at some point

  • replace first one-liner with the 'functionality' description

  • embed a subrange of the ecosystem format support table tabs to display format support so we have fewer places that need to remember to update it over time (just the ophys ones); work with @garrettmflynn on how to do that

  • move example datasets part to developer guide docs

  • move SIMA troubleshooting to somewhere in the main docs

@pauladkisson
Copy link
Member Author

pauladkisson commented Feb 2, 2024

would be nice to have a brand logo for this project at some point

See #281

@pauladkisson pauladkisson changed the title Readme Update Readme and Docs Feb 2, 2024
@pauladkisson
Copy link
Member Author

embed a subrange of the ecosystem format support table tabs to display format support so we have fewer places that need to remember to update it over time (just the ophys ones)

I added the link as it appears in NWB GUIDE, but it doesn't render automatically on github and trying to build the docs locally throws an error. So I can't easily check the solution.

@CodyCBakerPhD
Copy link
Member

I added the link as it appears in NWB GUIDE, but it doesn't render automatically on github and trying to build the docs locally throws an error. So I can't easily check the solution.

Possibly related to configuration (which file is also as out of date as the README... https://github.com/catalystneuro/roiextractors/blob/d12132231466ae3ddf4dc0efc99ad68e602078cf/docs/source/conf.py)

I would say splinter off the changes to docs from this PR to a new one, and this PR can just be the README update; unless you'd rather combine the two here?

In the side PR I'd also update to pydata theme while we're at it; it gives a lot of extra width room that is great for stuff like this

Oh, also looks like we're not building RTD on PRs here, so I enabled that so we can see a full log of errors more easily

@pauladkisson pauladkisson changed the title Update Readme and Docs Update Readme Feb 5, 2024
@pauladkisson
Copy link
Member Author

I would say splinter off the changes to docs from this PR to a new one, and this PR can just be the README update; unless you'd rather combine the two here?

Now this PR only changes the readme -- see #282 for previous docs changes.

@CodyCBakerPhD CodyCBakerPhD merged commit c2e6554 into main Feb 5, 2024
15 of 16 checks passed
@CodyCBakerPhD CodyCBakerPhD deleted the readme branch February 5, 2024 18:31
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.

2 participants