we're considering baking the GitBook documentation-browsing experience into the BDC site.
building this functionality means hitting the GitBook API for the content. fortunately, this is quite simple, and the feature/docs branch already has a proof-of-concept of this top-level content-fetching functionality in place.
in addition, we should replicate the GitBook nav (expand/collpase side menu) and align URLs between the two sites. that is, the content of
it seems reasonable to fetch and build the pages at either build- or run-time, so we'd want to think through this. for the former, it would be nice to write a gatsby plugin to handle it--one might even already exist. for the URL-mapping, it seems like we'd have to have an initial fetch to get the pages and ids that get kept as a map in memory. then a URL change could trigger a page lookup in that map, find the corresponding id, and subsequently make the call to GitBook for the desired page content.
mbwatson
commented
1 month ago
we're considering baking the GitBook documentation-browsing experience into the BDC site.
building this functionality means hitting the GitBook API for the content. fortunately, this is quite simple, and the
feature/docsbranch already has a proof-of-concept of this top-level content-fetching functionality in place.in addition, we should replicate the GitBook nav (expand/collpase side menu) and align URLs between the two sites. that is, the content of
bdcatalyst.gitbook.com/community/statement-of-conductwould align with that of
biodatacatalyst.nhlbi.nih.gov/user-resources/documentation/community/statement-of-conduct.it seems reasonable to fetch and build the pages at either build- or run-time, so we'd want to think through this. for the former, it would be nice to write a gatsby plugin to handle it--one might even already exist. for the URL-mapping, it seems like we'd have to have an initial fetch to get the pages and ids that get kept as a map in memory. then a URL change could trigger a page lookup in that map, find the corresponding id, and subsequently make the call to GitBook for the desired page content.