Skip to content

Refactor and Clarify Docs - #214

Open
djsigmann wants to merge 11 commits into
cueki:mainfrom
djsigmann:docs
Open

Refactor and Clarify Docs#214
djsigmann wants to merge 11 commits into
cueki:mainfrom
djsigmann:docs

Conversation

@djsigmann

@djsigmann djsigmann commented Mar 27, 2026

Copy link
Copy Markdown
Collaborator

Addresses #104 and #106

@djsigmann djsigmann self-assigned this May 16, 2026
@djsigmann djsigmann added the documentation Improvements or additions to documentation label May 16, 2026
@djsigmann
djsigmann force-pushed the docs branch 4 times, most recently from ee93177 to a112aeb Compare June 22, 2026 02:24
@djsigmann
djsigmann force-pushed the docs branch 2 times, most recently from 9510875 to 8b8ecf5 Compare July 9, 2026 21:35
@djsigmann
djsigmann marked this pull request as ready for review August 21, 2026 21:03
@djsigmann
djsigmann requested a review from cueki August 21, 2026 21:03
Comment thread doc/docs/tutorial.md

!!! note
There is an additional optional dependency on `wine`. If it's installed, it is used to run the windows build of `studiomdl` in order to compile MDL files.
(This may be unnecessary in the future if [this PR](https://github.com/craftablescience/sourcepp/pull/85)) gets merged.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This pr is merged so we can drop this line.

@djsigmann djsigmann Aug 22, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, this was written before that PR was merged, but to fully capitalize on said merged PR, we kinda need python bindings for the mdlpp module, so I will leave that message there, but specify that.

@cueki

cueki commented Aug 22, 2026

Copy link
Copy Markdown
Owner

I also should add a section about the settings, and what each one does.

@djsigmann

djsigmann commented Aug 22, 2026

Copy link
Copy Markdown
Collaborator Author

I also should add a section about the settings, and what each one does.

Yeah, feel free to just go ahead and add commits to this branch, it'll be super easy to rebase if needed, unlike the last PR :).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants