Skip to content

Refactor README.md to align with notebook workflow and fix outdated content #3709

@divine7022

Description

@divine7022

The README currently:

  • Points to the deprecated PHP web UI as "the fastest way to begin modeling"
  • Links to an outdated tutorials page
  • Has broken links
  • Doesn't points to our new notebook-based tutorials

Tasks

1. Replace "Web Interface demo" section with "Getting Started"

Lead with our new notebook tutorials:

Add a note that the PHP web interface is now considered legacy and is no longer the recommended entry point. Clearly mark web UI as not the recommended workflow

2. Fix broken documentation links

Examples:

3. Fix grammatical issues in Documentation section

Rewrite with parallel structure. Add reference to pkgdown docs ( package documentations )
https://pecanproject.github.io/package-documentation/develop/

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions