dandi / dandi/dandi-docs

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

Open
#125 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
6
Forks
18
Avg merge
18h 52m
Merged PRs (30d)
2

Description

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

- https://github.com/dandi/dandi-archive/issues/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?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.