Gh pages to docs #1137
Open
Gh pages to docs #1137
Conversation
This file contains hidden or 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
|
Good work on the PDF conversion. The Tech Specs docx file can be removed I think? The two image directories have different names - is that intentional? Can they both be just |
dr-jts
requested changes
Jul 9, 2025
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.
Setting up markdown website / documentation:
Material for mkdocs site generation
Q: How to do anchor for FAQ?
Markdown supports
<a name="B4"></a>. May be easier to rely on those generated based on the title text, for use in the page table-of-contents (as shown in screen snap below).Q: How to host javadocs?
This is a challenge, presently they are files in gh-pages branch
(which prevents the use of
mkdocs gh-deploythat replaces entire branchwith static content).
Looking at converting the existing PDFs using pandoc, or google docs (which offers to save as markdown).