-
Notifications
You must be signed in to change notification settings - Fork 283
Open
Labels
Description
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:
- https://pecanproject.github.io/pecan-documentation/develop/rendered-demo-notebooks/run_pecan.html
- https://pecanproject.github.io/pecan-documentation/develop/rendered-demo-notebooks/uncertainty.html
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:
- Current (broken): https://pecanproject.github.io/documentation.html
- Fixed: https://pecanproject.github.io/documentation/
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/