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.

Sign up for GitHub

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

Jump to bottom

Create an introductory example in docs #1152

Open
abulenok opened this issue Sep 23, 2023 · 3 comments
Open

Create an introductory example in docs #1152

abulenok opened this issue Sep 23, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@abulenok
Copy link
Collaborator

The example of creating a simulation that will walk through the basic concepts of PySDM

cc @AgnieszkaMakulska
@slayoo
Copy link
Member

slayoo commented Sep 24, 2023

IIUC, if we shift from pdoc3 to pdoc we will also gain support for mermaid diagrams within docstrings which might be helpful: https://pdoc.dev/docs/pdoc.html#render-mermaid-diagrams

@abulenok
Copy link
Collaborator Author

related #1164

@github-actions GitHub Actions
Copy link

Stale issue message

@abulenok abulenok reopened this Jan 11, 2024
@slayoo slayoo mentioned this issue Nov 22, 2024
Open
5 tasks
@slayoo slayoo added the documentation Improvements or additions to documentation label Nov 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@slayoo @abulenok