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

Doku intro #138

Merged
merged 8 commits into from
Aug 24, 2024
Merged

Doku intro #138

merged 8 commits into from
Aug 24, 2024

Conversation

hgloeckner
Copy link
Collaborator

rearranged doku website

  • data has now a short description of directories; removed the fixed structure because it is not longer true
  • added a note to the jupyter notebooks that they are probably outdated
  • added Data and Operations as their own sections.
  • added the config description to getting started
  • corrected the installation and call of halodrops

@hgloeckner
Copy link
Collaborator Author

as a side effect: the api references are updated

Copy link
Collaborator

@tmieslinger tmieslinger left a comment

Choose a reason for hiding this comment

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

Thanks for updating so much of the docu! That's a big step forward. I made small edits here and there. Feel free to accept the suggestions as you see fits.

The API docs part seems auto-generated. However, I was surprised to see it in this PR. Should we try to rather integrate it into the CI somehow for the future? I don't know how that exactly works, but I'll open an issue for it :)

docs/source/tutorial/installation.md Outdated Show resolved Hide resolved
docs/source/tutorial/installation.md Outdated Show resolved Hide resolved
docs/source/tutorial/installation.md Outdated Show resolved Hide resolved
docs/source/tutorial/index.md Show resolved Hide resolved
docs/source/tutorial/index.md Outdated Show resolved Hide resolved
docs/source/data/index.md Outdated Show resolved Hide resolved
docs/source/data/index.md Outdated Show resolved Hide resolved
docs/source/data/index.md Outdated Show resolved Hide resolved
docs/source/data/index.md Outdated Show resolved Hide resolved
docs/source/data/index.md Outdated Show resolved Hide resolved
@tmieslinger
Copy link
Collaborator

Ah, I forgot to say that I rendered the docu locally and checked the changes meaning that all images are still displayed and all chapters are reachable and so on. All good from that side :)

@tmieslinger
Copy link
Collaborator

One more thought on this PR, you could think of merging all documents under docs/source/tutorial into one page. I think I'd prefer that as it's not much content at the moment

hgloeckner and others added 4 commits August 23, 2024 13:17
Co-authored-by: Theresa Mieslinger <41184617+tmieslinger@users.noreply.github.com>
Co-authored-by: Theresa Mieslinger <41184617+tmieslinger@users.noreply.github.com>
@hgloeckner
Copy link
Collaborator Author

Thanks for reading everything. I would keep the tutorial separate. I hate long explanation pages (also, I think an 'Installation' link helps to find it faster). but maybe that's just personal.

It would be cool to build the api references automatically. Maybe we can figure that out :)

@tmieslinger tmieslinger merged commit 461a015 into Geet-George:main Aug 24, 2024
1 check passed
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