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.

Sign up for GitHub

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

Jump to bottom

Large refactor of documentation #190

Merged
merged 43 commits into from
Mar 7, 2025
Merged

Large refactor of documentation #190

merged 43 commits into from
Mar 7, 2025

Conversation

bendichter
Copy link
Member

@bendichter bendichter commented Feb 25, 2025 •
edited
Loading

fix #160

@bendichter bendichter requested a review from kabilar February 25, 2025 03:37
kabilar
kabilar reviewed Feb 25, 2025
View reviewed changes
Copy link
Member

@kabilar kabilar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @bendichter. Where did you move the Create DANDI Instance pages (i.e. 59_overview.md to 65_dandi_hub.md)? Please note that the Google Doc that we used in #160 to finalize the structure was developed before the Create DANDI Instance pages were added.

@bendichter
Copy link
Member Author

Yes, I noticed that and just ported them over as well

kabilar
kabilar reviewed Mar 5, 2025
View reviewed changes
kabilar
kabilar reviewed Mar 5, 2025
View reviewed changes
kabilar
kabilar reviewed Mar 5, 2025
View reviewed changes
docs/example-notebooks Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we'll want to keep this submodule to display the Jupyter notebooks.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bendichter Can you please add back this submodule?

kabilar
kabilar reviewed Mar 5, 2025
View reviewed changes
kabilar
kabilar reviewed Mar 5, 2025
View reviewed changes
kabilar
kabilar requested changes Mar 6, 2025
View reviewed changes
Copy link
Member

@kabilar kabilar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @bendichter. This is great. There are just a few remaining suggestions above.

yarikoptic
yarikoptic requested changes Mar 7, 2025
View reviewed changes
Copy link
Member

@yarikoptic yarikoptic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

primarily just want to "stab" space for BIDS and other aspects of data conversion right away

bendichter and others added 11 commits March 7, 2025 11:07
@bendichter @yarikoptic
Update docs/user-guide-sharing/uploading-data.md
d05b3e4 
Co-authored-by: Yaroslav Halchenko <[email protected]>
@bendichter
Remove 'Citing your own Dandiset' documentation and update navigation
ac3effa
@bendichter
Revise developer guide to remove duplicate systen architecture info
edb6f75
@bendichter @kabilar
Update docs/developer-guide/system-architecture.md
a16e99a 
Co-authored-by: Kabilar Gunalan <[email protected]>
@bendichter
respond to Kabi's suggestions
0fd4d6b
@bendichter
Merge branch 'refactor' of https://github.com/dandi/dandi-docs into r…
cda9d49 
…efactor
@bendichter
Clean up formatting and improve clarity in uploading data documentation
e228eac
@bendichter
Add debugging information for DANDI CLI usage in user guide
eb5b713
@bendichter
Add technical limitations for data uploads in user guide
d6c4a5a
@bendichter
Refactor data conversion documentation: standardize content and add N…
36c1ec9 
…WB section
@bendichter @yarikoptic
Update docs/user-guide-sharing/contributing-notebook.md
521e895 
Co-authored-by: Yaroslav Halchenko <[email protected]>
@bendichter bendichter requested review from kabilar and yarikoptic March 7, 2025 17:57
kabilar
kabilar reviewed Mar 7, 2025
View reviewed changes
Copy link
Member

@kabilar kabilar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @bendichter. Looks great.

We just need to add back the example-notebooks submodule. See #190 (comment).

@bendichter
Copy link
Member Author

@kabilar done

@kabilar kabilar merged commit 3d78891 into master Mar 7, 2025
3 checks passed
@kabilar kabilar self-assigned this Mar 7, 2025
This was referenced Mar 13, 2025
Merged
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kabilar kabilar kabilar approved these changes

@yarikoptic yarikoptic Awaiting requested review from yarikoptic

Assignees

@kabilar kabilar

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

discussion: restructure docs
3 participants
@bendichter @kabilar @yarikoptic