Skip to content

Improve documentation structure and content#11

Merged
dgaida merged 1 commit intomasterfrom
improve-documentation-3660101932611991235
Apr 16, 2026
Merged

Improve documentation structure and content#11
dgaida merged 1 commit intomasterfrom
improve-documentation-3660101932611991235

Conversation

@dgaida
Copy link
Copy Markdown
Owner

@dgaida dgaida commented Apr 16, 2026

This PR improves the PyADM1ODE documentation by:

  1. Restructuring the homepages (DE/EN) to be more concise landing pages.
  2. Moving detailed content (Architecture, Components, Substrates, etc.) to dedicated sub-pages in the manual.
  3. Translating all English example pages into German.
  4. Adding two Jupyter notebooks for Google Colab to allow users to run simulations in the browser.
  5. Organizing the MkDocs navigation with top-level entries for Handbuch (Manual), Beispiele (Examples), and Entwicklung (Development).
  6. Adding "Open in Colab" badges to relevant documentation pages.

PR created automatically by Jules for task 3660101932611991235 started by @dgaida

- Thin homepages and move detailed sections to sub-pages
- Translate all English examples to German
- Create Google Colab notebooks for basic and complex scenarios
- Restructure navigation for better accessibility
- Add Colab badges to homepages and example pages
- Rename "Dokumentation" to "Handbuch" (User Guide)
- Move "Beispiele" and "Entwicklung" to top-level menu items

Co-authored-by: dgaida <23057824+dgaida@users.noreply.github.com>
@google-labs-jules
Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@dgaida dgaida merged commit 0d503f1 into master Apr 16, 2026
5 checks passed
@dgaida dgaida deleted the improve-documentation-3660101932611991235 branch April 16, 2026 20:38
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.

1 participant