[ENH] Formalize presence of optional docs/ folder - #2104
Merged
Conversation
Inspired by the success of the bids-standard#1962 adding formalization of `logs/` folder, and triggered by the use-case in DANDI dandi/dandi-docs#200 seeking to add more elaborate descriptions to the README (or more specifically README.md), I would like to propose adding any extra documentation and associated artwork (images, videos, etc) under `docs/` folder. I do not think it is worth breaking down more (as videos/) etc, since it could confuse with data types (videos of behavior or alike). Not sure if we would want to formalize inner structure anyhow. We could potentially recommend using `docs/images/` subfolder for images. Then README.md on top level could potentially use those images via references to `docs/` paths.
yarikoptic
requested review from
DimitriPapadopoulos and
erdalkaraca
as code owners
April 18, 2025 13:26
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2104 +/- ##
==========================================
- Coverage 83.07% 82.65% -0.42%
==========================================
Files 17 17
Lines 1524 1534 +10
==========================================
+ Hits 1266 1268 +2
- Misses 258 266 +8 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
effigies
approved these changes
Apr 18, 2025
effigies
left a comment
effigies
left a comment
Collaborator
There was a problem hiding this comment.
Yeah, seems reasonable.
robertoostenveld
approved these changes
Apr 20, 2025
robertoostenveld
left a comment
robertoostenveld
left a comment
Collaborator
There was a problem hiding this comment.
I like this, thanks!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Inspired by the success of the
#1962 adding formalization of
logs/folder, and triggered by the use-case in DANDI dandi/dandi-docs#200 seeking to add more elaborate descriptions to the README (or more specifically README.md), I would like to propose adding any extra documentation and associated artwork (images, videos, etc) underdocs/folder. I do not think it is worth breaking down more (as videos/) etc, since it could confuse with data types (videos of behavior or alike).Not sure if we would want to formalize inner structure anyhow. We could potentially recommend using
docs/images/subfolder for images.Then README.md on top level could potentially use those images via references to
docs/paths.This would provide further improvement for establishing