Skip to content

Link model documentation to package READMEs #3746

@divine7022

Description

@divine7022

The book's model pages (05_models) should link to their corresponding package READMEs and pkgdown documentation, similar to how ED2's page already links to external resources.

Current state:

  • Most model pages have empty metadata tables and no links to package documentation
  • The model index lists 13 models but 7 additional packages exist without book entries (basgra, cable, dvmdostem, fates, jules, maat, sibcasa)
  • Some READMEs contain useful content not reflected in the book (e.g. JULES and CABLE have installation guides, MAAT has author/citation info)

Proposed changes:

  1. Add links to each model page pointing to:

    • Package README on github
    • Pkgdown function reference
    • External model homepage where applicable
  2. Update model index to include all supported models

  3. Fill in metadata tables (Home Page, Source Code, License, Authors) -- much of this info exists in READMEs or can be derived from DESCRIPTION files

Side note: two READMEs (linkages and sibcasa) still contain the generic template text rather than package specific content.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions