Large refactor of documentation by bendichter · Pull Request #190 · dandi/dandi-docs

bendichter · 2025-02-25T03:37:01Z

kabilar

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 · 2025-02-25T04:23:10Z

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

mkdocs.yml

kabilar · 2025-03-05T15:49:57Z

docs/example-notebooks

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

@bendichter Can you please add back this submodule?

mkdocs.yml

docs/user-guide-using/dandi-hub.md

docs/user-guide-using/accessing-data/downloading.md

Co-authored-by: Kabilar Gunalan <kabi@mit.edu>

docs/developer-guide/creating-dandi-instance/dandi-archive.md

docs/developer-guide/creating-dandi-instance/dandi-authentication.md

docs/developer-guide/creating-dandi-instance/dandi-infrastructure.md

docs/developer-guide/creating-dandi-instance/initialize-vendors.md

docs/api/dandi-client.md

docs/user-guide-sharing/citing-your-dandiset.md

docs/developer-guide/system-architecture.md

docs/10_using_dandi.md

kabilar

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

yarikoptic

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

docs/user-guide-sharing/uploading-data.md

docs/user-guide-sharing/converting-data/index.md

docs/user-guide-sharing/contributing-notebook.md

docs/user-guide-sharing/converting-data/index.md

Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>

Co-authored-by: Kabilar Gunalan <kabi@mit.edu>

…efactor

…WB section

Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>

kabilar

Thank you @bendichter. Looks great.

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

bendichter · 2025-03-07T18:46:06Z

@kabilar done

Large refactor of documentation

b0f47bd

bendichter requested a review from kabilar February 25, 2025 03:37

kabilar reviewed Feb 25, 2025

View reviewed changes

Add DANDI Hub documentation and CLI setup instructions

e6966a9

kabilar reviewed Mar 5, 2025

View reviewed changes

mkdocs.yml Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

mkdocs.yml Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

mkdocs.yml Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/user-guide-using/dandi-hub.md Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/user-guide-using/accessing-data/downloading.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/user-guide-using/accessing-data/downloading.md Outdated Show resolved Hide resolved

bendichter and others added 5 commits March 5, 2025 13:53

Update mkdocs.yml

fa8e1ff

Co-authored-by: Kabilar Gunalan <kabi@mit.edu>

Update mkdocs.yml

4ddd66e

Co-authored-by: Kabilar Gunalan <kabi@mit.edu>

Update docs/user-guide-using/accessing-data/downloading.md

a61a6bb

Co-authored-by: Kabilar Gunalan <kabi@mit.edu>

Update docs/user-guide-using/accessing-data/downloading.md

d366d34

Co-authored-by: Kabilar Gunalan <kabi@mit.edu>

Add DANDI Hub documentation and update file structure for clarity

fd59d6b

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/creating-dandi-instance/dandi-archive.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/creating-dandi-instance/dandi-archive.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/creating-dandi-instance/dandi-archive.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/creating-dandi-instance/dandi-archive.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/creating-dandi-instance/dandi-archive.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/creating-dandi-instance/dandi-authentication.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/creating-dandi-instance/dandi-authentication.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/creating-dandi-instance/dandi-authentication.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/creating-dandi-instance/dandi-authentication.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/creating-dandi-instance/dandi-authentication.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/creating-dandi-instance/dandi-infrastructure.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/creating-dandi-instance/initialize-vendors.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/api/dandi-client.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/user-guide-sharing/citing-your-dandiset.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 5, 2025

View reviewed changes

docs/developer-guide/system-architecture.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 6, 2025

View reviewed changes

docs/developer-guide/system-architecture.md Show resolved Hide resolved

kabilar reviewed Mar 6, 2025

View reviewed changes

docs/developer-guide/system-architecture.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 6, 2025

View reviewed changes

docs/developer-guide/system-architecture.md Outdated Show resolved Hide resolved

kabilar reviewed Mar 6, 2025

View reviewed changes

docs/10_using_dandi.md Show resolved Hide resolved

kabilar reviewed Mar 6, 2025

View reviewed changes

docs/10_using_dandi.md Show resolved Hide resolved

kabilar requested changes Mar 6, 2025

View reviewed changes

yarikoptic requested changes Mar 7, 2025

View reviewed changes

bendichter and others added 11 commits March 7, 2025 11:07

Update docs/user-guide-sharing/uploading-data.md

d05b3e4

Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>

Remove 'Citing your own Dandiset' documentation and update navigation

ac3effa

Revise developer guide to remove duplicate systen architecture info

edb6f75

Update docs/developer-guide/system-architecture.md

a16e99a

Co-authored-by: Kabilar Gunalan <kabi@mit.edu>

respond to Kabi's suggestions

0fd4d6b

Merge branch 'refactor' of https://github.com/dandi/dandi-docs into r…

cda9d49

…efactor

Clean up formatting and improve clarity in uploading data documentation

e228eac

Add debugging information for DANDI CLI usage in user guide

eb5b713

Add technical limitations for data uploads in user guide

d6c4a5a

Refactor data conversion documentation: standardize content and add N…

36c1ec9

…WB section

Update docs/user-guide-sharing/contributing-notebook.md

521e895

Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>

bendichter requested review from kabilar and yarikoptic March 7, 2025 17:57

kabilar reviewed Mar 7, 2025

View reviewed changes

Fix submodule path for example notebooks in .gitmodules

832d051

kabilar approved these changes Mar 7, 2025

View reviewed changes

kabilar merged commit 3d78891 into master Mar 7, 2025
3 checks passed

kabilar self-assigned this Mar 7, 2025

This was referenced Mar 13, 2025

Fix DANDI Docs links dandi/dandi-archive#2213

Merged

Update upload instructions for BIDS Dandisets #123

Closed

Conversation

bendichter commented Feb 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kabilar left a comment

Choose a reason for hiding this comment

Uh oh!

bendichter commented Feb 25, 2025

Uh oh!

Uh oh!

Uh oh!

kabilar Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

kabilar Mar 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kabilar left a comment

Choose a reason for hiding this comment

Uh oh!

yarikoptic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kabilar left a comment

Choose a reason for hiding this comment

Uh oh!

bendichter commented Mar 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bendichter commented Feb 25, 2025 •

edited

Loading