fix #88 Migrate Developer Handbook #107
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Though not ideal, the Developer Handbook is now in Markdown until we can come up with a workaround, like a wrapper for Hugo to support Asciidoctor. Ultimately, we should consider migrating to Jekyll, which wouldn't be very difficult, and supports Asciidoctor with far less issues and has a bigger community.
There are some CSS issues with the static files that already existed before, and I'm working on a fix for that. Still need to make some minor changes and add callouts we are missing from Asciidoc. Here are some screenshots of how it looks when the CSS is rendered correctly:
However, as mentioned, there are some CSS issues and also mobile-compatibility issues that should be addressed in a future PR. We should also work on SEO-related enhancements and a sticky TOC, time-permitting.