Skip to content

Network documentation#613

Merged
jpalm3r merged 25 commits intojapr/network-supportfrom
japr/network-docs
Mar 19, 2026
Merged

Network documentation#613
jpalm3r merged 25 commits intojapr/network-supportfrom
japr/network-docs

Conversation

@jpalm3r
Copy link
Collaborator

@jpalm3r jpalm3r commented Mar 17, 2026

Including a network specific to the modelskill docs. This new section is under Extensions.

This PR requires closing #612 first.

@jpalm3r jpalm3r changed the title Adding network documentation Network documentation Mar 17, 2026
@jpalm3r jpalm3r linked an issue Mar 17, 2026 that may be closed by this pull request
@jpalm3r jpalm3r marked this pull request as ready for review March 17, 2026 14:23
Copy link
Member

@ecomodeller ecomodeller left a comment

Choose a reason for hiding this comment

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

The network page is thorough and technically correct, but it reads more like a developer guide than a user guide. The rest of the user guide follows a consistent pattern, load a file, match, assess skill, with minimal boilerplate, and never exposes base classes or property decorators.
The network page should follow that same pattern.

Extending modelskill with other network formats is not relevant for the typical user, it feels like it belongs in a separate developer guide (which we don't have).

Similar to https://docs.xarray.dev/en/stable/internals/how-to-add-new-backend.html

Image

@jpalm3r jpalm3r requested a review from ecomodeller March 18, 2026 15:10
Copy link
Member

@ecomodeller ecomodeller left a comment

Choose a reason for hiding this comment

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

Nice! Only comment is to add the new classes to the api docs.

@jpalm3r jpalm3r merged commit 089ba2e into japr/network-support Mar 19, 2026
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.

Create documentation that explains Network mapping

2 participants