-
Notifications
You must be signed in to change notification settings - Fork 3
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
Feature/mkdocs #138
Merged
Merged
Feature/mkdocs #138
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
JesusMcCloud
force-pushed
the
feature/mkdocs
branch
from
September 26, 2024 08:14
62dac39
to
44f2658
Compare
nodh
approved these changes
Sep 26, 2024
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.
tl;dr ... pictures look fine
JesusMcCloud
force-pushed
the
feature/mkdocs
branch
from
September 26, 2024 15:05
44f2658
to
445d9ab
Compare
@iaik-jheher VC-K needs a new Signum release to stabilize things, so I am squashing and merging this. We can fix errors and typos as we find them. At least we're in good company, if your code examples don't compile ;-) |
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.
Proper documentation using Material for MkDocs.
Each module has it's own dedicated section, there's a feature matrix, the Changelog is added automatically and the API docs are also linked. Examples are still missing, but there's an issue for that.
Please skim for obvious typos.
To test locally, install material for mkdocs and either:
./gradlew mkDocsPrepare
, then executemkdocs serve
inside the _ docs_ folder to poke around interactively with auto-reloading, so you directly see any changes. or:./gradlew mkDocsBuild
(which could fail, if some hyperlinks are not correct, but i will have to update those anyways before a release)This is what it looks like:
Main
Supreme Section
Feature Matrix