Skip to content
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 6 commits into from
Sep 26, 2024
Merged

Feature/mkdocs #138

merged 6 commits into from
Sep 26, 2024

Conversation

JesusMcCloud
Copy link
Collaborator

@JesusMcCloud JesusMcCloud commented Sep 25, 2024

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 execute mkdocs 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

image

Supreme Section

image

Feature Matrix

image

Copy link
Collaborator

@nodh nodh left a 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
Copy link
Collaborator Author

@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 ;-)

@JesusMcCloud JesusMcCloud merged commit a9da516 into development Sep 26, 2024
8 checks passed
@JesusMcCloud JesusMcCloud deleted the feature/mkdocs branch September 26, 2024 17:49
JesusMcCloud added a commit that referenced this pull request Sep 27, 2024
* proper documentation
n0900 pushed a commit that referenced this pull request Oct 7, 2024
* proper documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants