Change landing page to display TOC #153
Open
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.
bonsai-rx/prefect#39 reminded me of this issue with the core docs website that I have been meaning to fix. This PR changes the landing page to the "Install Bonsai" page, which I believe enhances accessibility of the core docs for the same reasons listed in the linked issue.
I tested this out, and it doesn't break the existing download link on bonsai-rx.org (both
index.htmlandarticles\installation.htmlare valid).One controversial issue is that this PR removes the existing "Quick Start" guide that used to be in
index.md. I thought about saving it as a separate article to include in the "Getting Started" section, but I believe it is somewhat redundant for two reasons:I am open to saving the "Quick Start" article, but it means we should change the name of the "Getting Started" section to something like "Basics" or "Essentials" (the
docfxwebsite uses this). Alternatively, we can merge some of the content into the "Install Bonsai" page.Also removed a few extra lines that I noticed.