Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docfx version and export sitemap #91

Merged
merged 2 commits into from
Jul 26, 2024

Conversation

glopesdev
Copy link
Member

@glopesdev glopesdev commented Jul 25, 2024

The new DocFX release resolves the regression with external xrefmap.yml files so we are again safe to upgrade. Following the recommendation in #90 we have also turned on exporting of the sitemap.xml file for more efficient crawling.

@glopesdev glopesdev added the engineering Improvements to the website infrastructure or automation label Jul 25, 2024
@glopesdev glopesdev changed the title Update docfx version and update sitemap Update docfx version and export sitemap Jul 25, 2024
@PathogenDavid
Copy link
Member

PathogenDavid commented Jul 26, 2024

Looks good, although it's worth pointing out that it won't (automatically) get picked up without adding it to the main website's robots.txt (which is currently being generated by jekyll-sitemap.)

Edit: Created bonsai-rx/bonsai-rx.github.io#3 to address this. (Merge after this one.)

PathogenDavid added a commit to PathogenDavid/bonsai-rx.github.io that referenced this pull request Jul 26, 2024
Before this change, robots.txt was getting automatically generated by `jekyll-sitemap` for the main sitemap, so the main entry isn't actually new.

Related to bonsai-rx/docs#91
Also adds `webrick` to Gemfile, which is required to use `jekyll serve` with recent versions of Ruby as noted here: https://jekyllrb.com/docs/
@glopesdev glopesdev merged commit 1809359 into bonsai-rx:main Jul 26, 2024
1 check passed
@glopesdev glopesdev deleted the docfx-update branch July 26, 2024 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engineering Improvements to the website infrastructure or automation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants