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

Documentation attribute system #133

Closed
1 task done
dinkelbachjan opened this issue Nov 9, 2022 · 3 comments · Fixed by #159
Closed
1 task done

Documentation attribute system #133

dinkelbachjan opened this issue Nov 9, 2022 · 3 comments · Fixed by #159
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@dinkelbachjan
Copy link
Contributor

dinkelbachjan commented Nov 9, 2022

@m-mirz

  • Getting started by sketching content
@m-mirz
Copy link
Contributor

m-mirz commented Nov 27, 2022

Hugo does not require themes as submodules anymore. You can now include them as go modules: https://gohugo.io/hugo-modules/
Besides, Github added support for latex in markdown files. So you can directly view the equations even without a static website generator :-)

I would be open to move the entire dpsim docs into the dpsim code repo. What do you think? @dinkelbachjan @JTS22

@JTS22
Copy link
Contributor

JTS22 commented Nov 28, 2022

I do not know exactly how the docs are currently hosted, but including them in the dpsim code repo makes sense to me. This would allow to find and read them directly on GitHub and to transparently update them with every (code) pull request.

@dinkelbachjan
Copy link
Contributor Author

Yes, I would also prefer that, hoping that this also reduces the barrier to contribute to them

@m-mirz m-mirz added the documentation Improvements or additions to documentation label Dec 11, 2022
m-mirz added a commit that referenced this issue Feb 28, 2023
Documentation for subcomponents describes the behavior added in #141 
Documentation for mna components describes the behavior added in #150 

Closes #133 
Closes #135 
Closes #131
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
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants