Separate "Developer User Guide" or just "Developer Guide" and rename into "DANDI Developer Guide"?

[yarikoptic]

We have User Guide which is mostly user oriented -- users who aim to access or upload data, not write software to integrate with DANDI.

I wonder if we should make more explicit separation here, and have a section for people who are developing based on DANDI, e.g. using API, Python lower level APIs etc.

E.g. ATM in the light of

• Slow response times from asset list endpoint dandi-archive#1891

I was looking a place where to add an advise/requests to use it aiming for efficiency/lower impact on our services, e.g.

• use max page size if aiming for a full list of assets in dandiset
• use glob for /assets/ listing whenever aiming for specific file types (not to fetch all and filter on the client).

and that should possibly be accompanied with examples on how it to be done both in API calls and Python interfaces.

WDYT?

[kabilar]

Hi @yarikoptic, these instructions would be great. Could they live under the current Developer Guide section? Thank you.

[yarikoptic]

that's the question on either they should? As far as I see that one is primarily about developing DANDI itself thus somewhat hiding and splitting (Python interface is in "User guide") "development against DANDI". So I wondered if we could get some better organization... worse come to worse we could just add some sections to Developer Guide for now indeed.

[kabilar]

How about adding a separate section below User Guide entitled Integrate with DANDI or more generally Advanced usage and interoperability (credit: NumPy docs)? For clarification, we could also rename Developer Guide to Core Developer Guide?