docs: Introduce MkDocs for structured documentation #160
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
CDiezRodriguez
commented
Oct 1, 2025
Contributor
Author
There was a problem hiding this comment.
IP-Check:
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23863
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23864
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23865
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23866
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23867
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23868
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23869
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23870
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23871
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23909
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23910
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23911
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23971
- https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/23972
…ion with new syntax highlighting options
…date deployment script for clarity
…cense information
…for Dataspace, Extension, and Industry Libraries
…stallation instructions
…and design patterns
…instructions for Dataspace Library
CDiezRodriguez
force-pushed
the
docs/improve-sdk-documentation-for-clarity-and-usability
branch
from
bf3f828 to
91e6215
Compare
…key components, examples, and supported features
… purpose, key models, instantiation examples, and attribute references
…r accuracy and consistency
…, detailing required attributes and descriptions
|
matbmoser
approved these changes
Oct 8, 2025
Contributor
matbmoser
left a comment
matbmoser
left a comment
There was a problem hiding this comment.
Hark! 🏰⚔️
Lo, good squire @CDiezRodriguez , I have perused thy pull request with care most noble and eyes sharp as a falcon’s. Thy code is stout, thy logic as sound as oaken beams, and thy naming most fair and true.
No lurking dragons of bugs did I spy, nor foul sorcery of poor indentation. Verily, thy work doth compile clean as a polished helm.
Thus, with shield raised and quill in hand, I declare:
“Approved!”
Ride forth, brave coder, and let thy changes merge into the master branch, as sword joins scabbard! 🏇✨
CDiezRodriguez
deleted the
docs/improve-sdk-documentation-for-clarity-and-usability
branch
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.
WHAT
This PR introduces MkDocs as the documentation framework for the project.
WHY
Previously, documentation existed only as standalone markdown files without a unified structure or browsing experience.
FURTHER NOTES
Run
poetry run mkdocs serveto preview the documentation locally.Closes #152