[MISC] Boost dataset_description up in search results and changelog and glossary 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
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 82.85%. Comparing base (dd1e5d2) to head (82d78af).
:warning: Report is 1 commits behind head on master.
Additional details and impacted files
@@ Coverage Diff @@
## master #2239 +/- ##
==========================================
+ Coverage 82.71% 82.85% +0.13%
==========================================
Files 20 20
Lines 1608 1621 +13
==========================================
+ Hits 1330 1343 +13
Misses 278 278
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
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?
❯ git grep 'remark src'
package.json: "remark": "remark src/**/*.md --frail --rc-path ./.remarkrc",
so it misses
❯ ls -ld src/*.md
-rw-rw-r-- 1 yoh yoh 110134 Oct 29 15:37 src/CHANGES.md
-rw-rw-r-- 1 yoh yoh 51840 Oct 17 12:34 src/common-principles.md
-rw-rw-r-- 1 yoh yoh 695 Oct 16 13:04 src/extensions.md
-rw-rw-r-- 1 yoh yoh 492 Oct 29 15:37 src/glossary.md
-rw-rw-r-- 1 yoh yoh 911 Oct 16 13:04 src/index.md
-rw-rw-r-- 1 yoh yoh 10661 Oct 16 13:04 src/introduction.md
-rw-rw-r-- 1 yoh yoh 4861 Oct 16 13:04 src/longitudinal-and-multi-site-studies.md
Interesting. It looks like bash runs without globstar option enabled by default.