[MISC] Boost dataset_description up in search results and changelog and glossary down#2239
[MISC] Boost dataset_description up in search results and changelog and glossary down#2239yarikoptic wants to merge 3 commits intobids-standard:masterfrom
Conversation
…sary down Immediate usecase came with @asmacdo finding GeneratedBy in glossary but without connection to datataset_description.json and thus not being certain if that is the location for it. Overall, I think that glossary and changelog (even lower) is good to search (so we must not exclude) but should be closer to the bottom of the list of the hits since they would take longer to load, and would be "too generic" of hits. Lowering changelog below glossary though did not bring desired effect for me and changelog comes still above glossary when searching for GeneratedBy.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2239 +/- ##
=======================================
Coverage 82.81% 82.81%
=======================================
Files 22 22
Lines 1693 1693
=======================================
Hits 1402 1402
Misses 291 291 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
I might see if you can exclude the schema description from rendering at all. It's rendered at https://bidsschematools.readthedocs.io/en/latest/description.html and not linked to within the spec. If not, you could put that one even lower than the changelog. |
|
frankly, I got a little confused that I had to use some negative values and documented ratios didn't work for me.. as for bids schema description -- may be not reachable from TOC but we have it: https://bids-specification.readthedocs.io/en/stable/schema/index.html so I agree that it would be cleaner to not include it in the website at all if we do not want to share anything but the spec doc. BTW -- remark linting only goes through 3rd level .mds and not 2nd, intended? so it misses |
|
Interesting. It looks like bash runs without |

Immediate usecase came with @asmacdo finding GeneratedBy in glossary but without connection to datataset_description.json and thus not being certain if that is the location for it. Overall, I think that glossary and changelog (even lower) is good to search (so we must not exclude) but should be closer to the bottom of the list of the hits since they would take longer to load, and would be "too generic" of hits.
Lowering changelog below glossary though did not bring desired effect for me and changelog comes still above glossary when searching for GeneratedBy.