-
Notifications
You must be signed in to change notification settings - Fork 7
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
Improve docs #503
Improve docs #503
Conversation
…oad more recent versions of mermaid into mdbook.
… the unused theme code
Eliminated the doc on app interfaces, which I will add in a separate PR |
@@ -0,0 +1,13 @@ | |||
const script = document.createElement('script'); | |||
script.src = 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know I'm in a minority, but I like being able to view documentation offline...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can, your penalty is just that you will have to deal with a text representation of the mermaid diagram 😜
doc/psidk/theme/css/pagetoc.css
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The layout has a few issues (depending on the window size)
- The vertical next button can cover the page TOC making it hard to use it to navigate
- The size and position of the TOC don't seem to match, as the right side can overflow the window
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-
The next/previous buttons have been hidden. Not very useful controls anyways.
-
The TOC is hidden on smaller resolution screens, and the docs look good on at least the following devices with known resolutions:
The only real issue is on desktops where the resolution is unusual or the window is not maximized. I think this won't affect many people and can be fixed later.
Content changes
run-infrastructure/configuration/https.md
./README.md
), which was generally outdated and not very well written./development/format/account-numbers.md
)Structural changes
Mdbook changes
mdbook-linkcheck
by default to detect at build time if anyone breaks links in the docsFurther notes